Skip to content

groupsInCurrentAndDescendantOrganization

Retrieve groups from current and descendant organizations based on the specified filters.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String Returns the elements in the list that occur after the specified cursor.
last Int Returns the last n elements from the list.
before String Returns the elements in the list that occur before the specified cursor.
filter GroupFilterInput Specifies user group filters.
sortBy GroupSortByParam Specifies sort parameter.
shouldIncludeGroupsWithoutRole Boolean Specifies whether to include user groups without any assigned roles either in the current or descendant orgs. If roleIdsFilter is not empty, this field is always considered as false.

Returns

GroupConnection!

Sample

query {
  groupsInCurrentAndDescendantOrganization(first: 10) {
    nodes {
      domainName
      groupId
      groupName
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
{}
{
  "data": {
    "groupsInCurrentAndDescendantOrganization": {
      "nodes": [
        [
          {
            "domainName": "example-string",
            "groupId": "example-string",
            "groupName": "example-string"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}