Get client

Retrieve a single client by its ID.

Access with

Organization access token with clients.read

Path Params
string
required

Provide the ID of the related organization.

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

Language
Credentials
Bearer
Request
Response
Choose an example:
application/hal+json