listGroupMembers( )

Lists all members of a group.

The listGroupMembers() function returns a Promise that resolves to a list of up to 100 group members. Sorts by default to joinedDate in descending order.

Notes:

  • For SECRET groups, only site admins, group admins, and group members can see the list of group members. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can see the list of group members.
  • This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use null as a placeholder for any unspecified parameters. For example, to specify limit only, call listGroupMembers(groupId, paging, null). To specify supressAuth only, call listGroupMembers(groupId, null, options).
Method Declaration
Copy
Method Parameters
groupIdstringRequired

Group ID.

pagingPaging

Paging options.

optionsOptions

Authorization options.

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