Skip to content

List Agency Clients

GET
/agency/clients

List the client orgs this agency key may target via X-Target-Org-Id.

Each entry’s org_id is the value to pass in the X-Target-Org-Id header on any subsequent request to operate that client org.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string