Skip to main content

Pagination

List endpoints (the various Listing and Find operations) return results in pages. A paged response carries the results in data and paging metadata in a pagination object alongside it.

Requesting a page

Pass paging via query parameters. The common ones are:

ParameterTypeMeaning
pageintegerWhich page to return (1-based).
per_pageintegerItems per page.
limitintegerMaximum items to return.
curl "https://www.acmdestiny.net/api/v1/units/listing?page=2&per_page=50" \
-H "Authorization: bearer YOUR_TOKEN"
note

Not every list endpoint accepts every parameter — check the specific operation in the API Reference for the exact query parameters it supports. The reference now types these parameters (e.g. per_page is an integer), so you can see at a glance what each one expects.

Reading the response

{
"data": [ /* the page of results */ ],
"pagination": {
"page": 2,
"per_page": 50,
"total": 1234
}
}

Use the pagination fields to decide whether to fetch the next page. Keep requesting until you've retrieved total items (or until a page returns fewer than per_page results).

Tips

  • Prefer the most specific list endpoint for your context (e.g. Units Listing By Client over Units Listing) — it returns less data and is faster.
  • Keep per_page reasonable; very large pages are slower and heavier on both ends.