The groupsPage() GraphQL query returns all of the defined groups in an organization. This field is not yet available. It's described here as a preview and is used for new pagination pattern.

For more information on user groups, see the Managing Groups documentation page.


Below is the syntax for the groupsPage() query field:

   search: string
   pageNumber: integer!
   pageSize: integer!
): GroupPage!

Returned Datatypes

The returned datatype GroupPage has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: GroupPage

pageInfoPageTypeyes Information about the group page (see PageType Table).
page[Group]yes A list of groups (see Group Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.