Get Clients

The allClients query returns all Clients (service accounts) available in your organization.

A client identifies the application or integration component that makes requests to the platform.

Use this endpoint when you need to:

• List available client identities in your organization
• Build a minimal client directory for internal checks
• Validate that your integration can retrieve client names

Query Overview

Path: admin/get-clients/

GraphQL root:

admin {
  allClients {
    edges {
      node {
        clientData {
          ...
        }
      }
    }
  }
}

The response is a connection, so you can read:

• edges: list of clients
• totalCount: total number of clients in your organization

Simple Clients Request

Use this version for a minimal list of available client names.

Returned fields:

• name

Query Example

Simple Request

This example retrieves a list of all clients with their basic details.

query {
  admin {
    allClients {
      edges {
        node {
          name
          code
          group
        }
      }
    }
  }
}

Variables Example

This query does not require variables.

{}

Response Example

Here is an example of the response:

{
  "data": {
    "admin": {
      "allClients": {
        "edges": [
          {
            "node": {
              "name": "client-name-1",
              "code": "client-code-1",
              "group": "client-group-1"
            }
          },
          {
            "node": {
              "name": "client-name-2",
              "code": "client-code-2",
              "group": "client-group-2"
            }
          }
        ]
      }
    }
  }
}

Response Considerations

• In this sample, the response includes only name because it is the only field requested.
• If requested, code follows the client identifier format used by the platform.
• If requested, group helps understand where the client belongs in your organization hierarchy.

Common Use Cases

• List Client Identities: Retrieve a list of all the clients in your organization for internal audits.
• Validate Client Permissions: Ensure that client accounts have the correct permissions for API operations.
• Build Client Directories: Create a directory of client accounts for operational monitoring and troubleshooting.

Troubleshooting

Here are some common issues and their resolutions when using the allClients query:

1. No clients returned:

   • Cause: The organization has no registered clients.
   • Resolution: Verify that clients have been created in the API Settings section of our Platform.

2. Permission denied error:

   • Cause: The API key or Bearer token used does not have sufficient permissions.
   • Resolution: Ensure the API key or Bearer token has the required ADMIN permissions.

3. Query timeout:

   • Cause: The query is fetching a large number of clients.
   • Resolution: Use pagination to limit the number of results returned in a single query.