Skip to main content
GET
cURL

Authorizations

X-Api-Key
string
header
required

Path Parameters

organization_uuid
string<uuid>
required

Query Parameters

ordering
string

Order results by created date. Use '-created' for descending (newest first) or 'created' for ascending (oldest first).

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

query
string

Search query to filter clients (case-insensitive partial match). Searches across both external_id and any values within the metadata.

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"