Pagination & Search

A list request (such as all clients or all messages) may match thousands of results. Rather than returning everything at once (which would be slow and use a lot of memory), the API sends results in pages, similar to pages of search results on Google. Pages are requested one at a time, and the number of records per page is configurable.

All list endpoints support pagination and search through query parameters.

Query Parameters

Parameter	Description	Default
limit	Number of records to return	10
skip	Number of records to skip	0
sort	Field to sort by	created_at
sortDirection	Sort direction: asc or desc	desc
search	Full-text search query	-

Example

Retrieve the first 25 records, sorted by creation date descending:

GET /v1/clients?limit=25&skip=0&sort=created_at&sortDirection=desc

Searching by Reference

Look up a specific client by reference:

GET /v1/clients?client_reference=CLIENT-12345

Look up a specific event by reference:

GET /v1/events?event_reference=EVENT-12345

Filtering by Relationship

Retrieve all contacts associated with a specific client:

GET /v1/contacts?client={client_uuid}

Replace {client_uuid} with the UUID of the client record.