Pagination - Aptly API

List endpoints in the Aptly API return results one page at a time. Use the page query parameter to walk through all records.

Parameters

Parameter	Type	Default	Description
`page`	integer	`0`	Zero-indexed page number. Start at `0` and increment by `1` for each subsequent request.
`pageSize`	integer	`20`	Number of records per page. Maximum is `1000`.

Example

# First page
curl "https://core-api.getaptly.com/api/board/{boardId}?page=0&pageSize=100" \
  -H "x-token: YOUR_API_KEY"

# Second page
curl "https://core-api.getaptly.com/api/board/{boardId}?page=1&pageSize=100" \
  -H "x-token: YOUR_API_KEY"

Detecting the last page

The response includes a count field representing the total number of matching records. You have reached the last page when the following is true:

(page + 1) * pageSize >= count

Example: if count is 112 and your pageSize is 50, you need three pages (pages 0, 1, and 2). On page 2 you will receive the remaining 12 records.

Iterating all records

To collect all cards on a board:

Fetch page 0 and read count from the response
Calculate the number of pages: Math.ceil(count / pageSize)
Fetch each subsequent page until you have all records

Avoid storing page numbers as persistent cursors. If cards are added or removed between requests, page boundaries can shift. For reliable sync, use a timestamp filter if available or reconcile by card ID after fetching all pages.