Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt

Use this file to discover all available pages before exploring further.

List endpoints support consistent query parameters for pagination, filtering, and sorting.

Pagination parameters

ParameterDefault / Max
page · integerdefault 1
perPage · integerdefault 10, max 1000
Pagination metadata is in response headers, not in the body.
Paginated responses carry metadata in HTTP response headers:
HeaderValue
X-Pagination-Current-PageCurrent page number
X-Pagination-Total-CountTotal items across all pages
X-Pagination-Page-CountTotal number of pages
X-Pagination-Per-PagePage size used for this request
Example response with headers:
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "Affiliates List",
  "info": { "affiliates": [] }
}
X-Pagination-Current-Page: 2
X-Pagination-Total-Count: 137
X-Pagination-Page-Count: 7
X-Pagination-Per-Page: 20

Sorting

ParameterValues
sortFieldendpoint-specific field name
sortDirectionasc (default) | desc
GET /api/v2/network/affiliates?sortField=created_at&sortDirection=desc&page=1&perPage=50

Filtering

ParameterMeaning
field=valueExact match — e.g. status=1
field[]=v1&field[]=v2Match any value — e.g. country[]=US&country[]=GB
field_from / field_toDate or numeric range
qFull-text search

Date format

All date and datetime filters accept ISO 8601. If no timezone is given, UTC is assumed.
  • Date only: 2026-01-20
  • Datetime UTC: 2026-01-20T13:45:00Z