Sign in

v1

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

Get client

Retrieve a single client by its ID.

🔑 Access with

Advanced access token with clients.read

get/v2/clients/{organizationId}

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.

Response

The client object.