groups

List all groups in your organization.

Returns a paginated, sortable list of groups. By default, groups are sorted alphabetically by name.

Example:

query {
  groups(organizationId: "my-org") {
    data {
      id
      name
      role
      description
    }
    cursor { next }
  }
}

groups(
  organizationId: ID!
  sort: GroupsSort
  cursor: Cursor
): GroupsPage

Arguments

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

Your organization's unique identifier.

groups.sort ● GroupsSort input {#sort}

Sort field and direction. Defaults to name ascending.

groups.cursor ● Cursor input {#cursor}

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

Type

GroupsPage object