listGroups( )

Lists groups.

The listGroups() function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to _createdDate in descending order.


  • For SECRET groups, only site admins, group admins, and group members can see a list of group and their content. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can see a list of groups and their content.
  • 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 listGroups(paging, null). To specify supressAuth only, call listGroups(null, options).
Method Declaration
Method Parameters

Paging options.


Authorization options.

Return Type:Promise<ListGroups>
Was this helpful?