Skip to main content

Get Clients

Retrieve a paginated list of clients in your organisation.

Endpoint

GET /clients

Parameters

ParameterTypeDescriptionRequired
pageintegerThe page number for pagination (default: 1)No

Response

A successful response will return a 200 OK status code and a JSON object containing the list of clients and pagination metadata.

{
"data": [
{
"uuid": "473a14ab-7374-468a-8276-485a93896a27",
"name": "My First Client"
},
...
],
"pagination": {
"current_page": 1,
"per_page": 20,
"total_pages": 1,
"total_items": 4
}
}