Skip to main content

groups

List all groups in your organization.

Returns a paginated, sortable list of groups. By default, groups are sorted alphabetically by name. Use filter to search groups or to list the groups of one account or service account.

Note: when a search filter is active, pagination cursors are offset-based and are not interchangeable with the cursors returned by queries without search.

Example:

query {
  groups(organizationId: "my-org", filter: { search: "platform" }) {
    data {
      id
      name
      role
      description
    }
    cursor { next }
  }
}
groups(
  organizationId: ID!
  filter: GroupsFilter
  sort: GroupsSort
  cursor: Cursor
): GroupsPage

Arguments​

groups.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

groups.filter ● GroupsFilter input {#filter}​

Narrow results by search, account, or service account.

groups.sort ● GroupsSort input {#sort}​

Sort field and direction. Defaults to name ascending. When a search filter is active and no sort is provided, results are ranked by relevance.

groups.cursor ● Cursor input {#cursor}​

Pagination cursor returned from a previous response to fetch the next page.

Type​

GroupsPage object​