Pagination, filtering, and sorting
Most list endpoints return a paginated collection with a meta.pagination object. The common query parameters are:
| Parameter | Meaning |
|---|---|
page |
1-based page number. |
perPage |
Number of records requested for the page, subject to the endpoint limit. |
sort |
A field and direction such as created_at,desc. |
filters |
Endpoint-specific deep-object filters such as filters[status:eq]=running. |
The exact fields and limits are operation-specific. Read the endpoint parameters in the API reference before constructing a query.
Example
curl --get 'https://api.blogvault.net/api/v6/sites?page=1&perPage=20' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Accept: application/json'
Use the returned totalPages and totalItems values to decide when to stop. Keep the requested sort explicit when a workflow spans multiple pages, and use the endpoint’s documented timestamp and timezone rules for date filters.
Invalid combinations
An unsupported field, operator, or value is rejected with a validation response. Do not silently drop filters: log the request parameters and surface the API’s structured error details to the caller.