Skip to content

Pagination

List endpoints use cursor-based pagination, not offsets or page numbers.

Only four list endpoints paginate:

  • /subscribers
  • /segments
  • /campaigns
  • /templates

There is no total count and no offset or page parameter on any of them.

  • limit: how many items to return. Defaults to 25 and is clamped to the range 1 to 100 rather than rejected when you pass a value outside it. A non-numeric limit returns 400.
  • cursor: an opaque, account-bound token. Pass back the next_cursor value from a previous response to get the next page. A cursor that cannot be decoded, or one that belongs to a different account, returns 400.
{
"data": [ ... ],
"next_cursor": "<opaque>"
}

next_cursor is null on the last page.

Request the first page:

Terminal window
curl "https://api.boostmail.app/v1/subscribers?limit=100" \
-H "Authorization: Bearer bm_live_..."
{
"data": [ ... ],
"next_cursor": "<opaque-cursor>"
}

Pass next_cursor back as the cursor query parameter to get the next page:

Terminal window
curl "https://api.boostmail.app/v1/subscribers?limit=100&cursor=<opaque-cursor>" \
-H "Authorization: Bearer bm_live_..."
{
"data": [ ... ],
"next_cursor": null
}

next_cursor: null means you have reached the last page. Stop paging.

See the Errors guide for what a 400 response looks like.