List Clients (DataTable)
Retrieve a paginated list of clients with advanced filtering, sorting, and field selection.
GET
/datatable-clients
Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
range |
integer | Items per page (default: 25) | ?range=50 |
page |
integer | Page number (0-indexed) | ?page=2 |
sort |
string | Sort field and direction | ?sort=-updated |
filter[status] |
string | Client status | ?filter[status]=approved |
global_search |
string | Search across multiple fields | ?global_search=john |
Example Requests
GET /api/v1.0/datatable-clients?range=25&sort=-updatedGET /api/v1.0/datatable-clients?filter[status]=approved&filter[country]=US&sort=-updated&range=25GET /api/v1.0/datatable-clients?filter[uuid][value][0]=abc123&filter[uuid][value][1]=def456&filter[uuid][operator]=INResponse
{
"data": [
{
"id": "123",
"uuid": "abc-def-123",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"status": { "id": "approved", "label": "Approved" },
"balance": { "value": 1250.50, "formatted": "$1,250.50" },
"updated": "2025-10-15T14:30:00Z"
}
],
"count": 342
}