List clients

Retrieve a list of all clients linked to your account.

The results are paginated.

Access with

Organization access token with clients.read

Query Params
string | null

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.
string

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.

integer | null
1 to 250
Defaults to 50

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

Responses

Language
Credentials
Bearer
LoadingLoadingโ€ฆ
Response
Choose an example:
application/hal+json