Working with data
Pagination, sorting & filtering
List endpoints share a common set of controls for paging, ordering, and filtering results.
Pagination
| Intent | Parameter |
|---|---|
| Page number | page=2 |
| Page size | limit=25 |
| Offset window | limit=50,25 (offset, count) |
| Disable paging | limit=false |
curl -s "https://api.readycms.io/products/?namespace=<tenant>&limit=25&page=2" \ -H "Authorization: Bearer <app_id>:<app_secret>"
Most list endpoints also have a count variant (append /count/) so you can fetch totals separately.
Note
There is a server-side maximum page size (typically 500). For large exports, page through results or use performance flags.
Sorting
- Legacy:
order_by=created&order_by_type=DESC - Multiple fields:
order_by=price,title - Per-field direction:
order_by=price DESC, title ASC - Shorthand:
order_by=-price,title(leading-= descending)
Filtering
Most filters are endpoint-specific query parameters, documented per endpoint in the reference. A few conventions apply everywhere:
- Free-text search uses
q; filter by multiple ids withid_in. filtermay be passed as a JSON string; it is decoded server-side.wheremay be passed as a JSON string on endpoints that support it.
For filtering by custom headless fields, see Filtering by headless fields.