Pagination
List endpoint pagination and sorting parameters.
List endpoints use page-based pagination.
Query parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
page | integer | 0 | Zero-based page number |
limit | integer | 10 | Items per page |
sort_by | string | created_at | Field passed to the backend sort layer |
sort_order | string | desc | Use asc or desc |
curl "https://api.getpaidhq.com/api/customers?page=0&limit=25&sort_by=created_at&sort_order=desc" \
-H "Authorization: Bearer YOUR_API_KEY"Negative page values are treated as 0. Missing or invalid limit values
fall back to 10.
Response shape
Most list endpoints return:
{
"data": [
{
"id": "cus_123",
"email": "customer@example.com"
}
],
"meta": {
"total": 1,
"page": 0,
"limit": 25
}
}Some dunning list endpoints use a simpler shape:
{
"data": [],
"total": 0
}The current OpenAPI spec does not expose cursor pagination or generic filtering parameters.