Get Agency Client

GET

/agency/clients/{org_id}

• Production
• QA

One client of this agency, suspended ones included. 403 for any org that is not this agency’s client.

Authorizations

• BearerAuth

Parameters

Path Parameters

org_id

required

Client org id (org_xxx) from GET /agency/clients.

string

Client org id (org_xxx) from GET /agency/clients.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

created

Any of:

boolean

boolean

null

null

external_ref

Any of:

string

string

null

null

name

required

string

org_id

required

Client org id (org_xxx). Send it as X-Target-Org-Id.

string

owner_invite

Any of:

string

string

Allowed values: invited existing_account failed

null

null

provisioning

required

pending until the org’s workspace has been set up; targeting it answers 503 until then.

string

Allowed values: ready pending

status

required

string

Allowed values: active suspended

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string