List Users Available to Become Group Owners

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
Permissions: Your token must be allowed to manage the group. Read access on the organization is not enough.
Group UUID: Identify the group whose future owners you want to list. Use List Organization Groups to discover group UUIDs.

Step 1: Find the Group UUID

List an organization's groups with List Organization Groups and take the uuid of the group you want.
See our Get resource IDs page for more on retrieving resource identifiers.

Step 2: List Users Who Can Become Owners

The usersAvailableToBecomeGroupOwners query returns a paginated connection of organization users who can still be made owners of the group. It includes billable, confirmed users and leaves out people who are already owners, guests, and users who have not confirmed their account.

query {
  usersAvailableToBecomeGroupOwners(
    groupUuid: "group-uuid-here"
    searchTerm: "ada"
    first: 10
  ) {
    edges {
      node {
        id
        email
        name
        uuid
        avatarUrl
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

Arguments

groupUuid (ID!, required): the UUID of the group.
searchTerm (String, optional): filter the users by name or email. Omit it, or send an empty string, to return every eligible user.
Standard connection arguments (first, after, last, before) control pagination. The page size is at most 50.

Sample response

{
  "data": {
    "usersAvailableToBecomeGroupOwners": {
      "edges": [
        {
          "node": {
            "id": "456",
            "email": "[email protected]",
            "name": "Ada Lovelace",
            "uuid": "user-uuid-here",
            "avatarUrl": "https://app.pipefy.com/avatar.png"
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "cursor"
      },
      "totalCount": 1
    }
  }
}

Key Notes

Permissions: the caller must be allowed to manage the group. Without that permission the response is Permission denied. An unknown groupUuid returns a not-found error (Couldn't find Group with ...).
Who is listed: billable organization roles only. Company guests, external guests, existing group owners, and unconfirmed users are excluded.
Pagination: this query is a connection, so totalCount reports the full count regardless of the first/after window. Pair it with pageInfo to page through large organizations. Each page holds at most 50 users.
Related: after you pick a user, see Retrieve a Group, Its Owners, Users, and Available Interfaces to read the group's current owners.