Read clients

Retrieves clients accessible to the authenticated API user.

Supports a single exact-match lookup by client_name or a full list
of accessible clients with pagination. If neither parameter is
supplied, the endpoint returns a paginated list of all clients
accessible to the authenticated user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Optional client ID to scope the read to a specific client.
This is only used when the authenticated API key has access
to that client.

string

Retrieve a single client by its exact name.

integer
≥ 0
Defaults to 50

Maximum number of records returned for collection queries.
Defaults to 50.

integer
≥ 0
Defaults to 0

Number of records to skip for collection queries.
Defaults to 0.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json