Sign in
latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Organizations Agency

Get clients

REQUIRED SCOPES <code>['organizations-agency:read']</code><br>Fetches a list of clients based on specified criteria.

get/agency/clients

Query parameters

sortBystring
Example:name

Field to sort by

sortOrderstring
Example:asc

Sort order

allboolean

Fetch all clients without pagination

searchstring

Search term

lengthinteger
Example:20

Number of results per page

pageinteger
Example:1

Page number

fields_liststring[]

List of specific fields to return

Response

Successful retrieval of client list

OR

Example response

[
  {
    "id": 1,
    "name": "SalesMessage Inc.",
    "country": "US",
    "is_agency": true,
    "agency_id": 321,
    "vendor_id": "vnd-567",
    "stripe_id": "stripe-5678",
    "created_at": "2024-03-18T14:23:00Z",
    "updated_at": "2024-03-19T10:15:00Z"
  }
]