listMembersByBadge( )


Lists the IDs of all members assigned to a badge.

The listMembersByBadge() function returns a Promise that resolves to a list of member IDs assigned to the specified badge.

Retrieves up to 1000 site members who have a specified badge. Default paging.limit is 100, paging.offset - 0.

The _id parameter must be an ID from your site's Members/Badges collection. Typically, you retrieve the ID from the collection using a query or through a dataset.

This function is not a universal function and runs only on the backend.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Badges
Read Badges
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Badge ID.


optionsListMembersByBadgeOptions
Returns
Return Type:Promise<ListMembersResponse>
Was this helpful?
Yes
No