Sign in

v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Clients API

List clients

Retrieve a list of all clients linked to your account.

The results are paginated.

🔑 Access with

Advanced access token with clients.read

get/v2/clients

Query parameters

embedstring nullable
Example:organization

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

  • organization: Include the organization of the client. Available for signuplink partners, or for oauth partners with the organizations.read scope.
  • onboarding: Include the onboarding status of the client. Available for signuplink partners, or for oauth partners with the onboarding.read scope.
  • capabilities: Include the capabilities of the client organization. Available for oauth partners with the onboarding.read scope.
fromstring
Example:org_12345678

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

Response

A list of client objects. For a complete reference of the client object, refer to the Get client endpoint documentation.