Pagination

All list endpoints in the Bardge API use cursor-based pagination. Cursors are more stable than offset pagination — they do not skip or repeat records when items are added or removed between requests.

How it works

List endpoints accept three query parameters:

Parameter	Type	Default	Description
`starting_after`	string	—	Return results after this resource ID (exclusive)
`ending_before`	string	—	Return results before this resource ID (exclusive)
`limit`	integer	`10`	Maximum number of results to return. Between 1 and 100.

Use starting_after to page forward, ending_before to page backward.

List response envelope

Every list response wraps its data in a standard envelope:

{
  "object": "list",
  "data": [
    { "object": "pass", "id": "pass_01H8XYZABCDE", ... },
    { "object": "pass", "id": "pass_01H8XYZABCDF", ... }
  ],
  "has_more": true,
  "url": "/v3/api/business/reseller/passes",
  "message": "Passes retrieved successfully"
}

Field	Description
`object`	Always `"list"`
`data`	Array of resources for this page
`has_more`	`true` if there are more results beyond this page
`url`	The URL of this list resource
`message`	Human-readable description of the result

Paging through results

First page:

GET /passes?limit=20

Next page — take the id of the last item in data and pass it as starting_after:

GET /passes?limit=20&starting_after=pass_01H8XYZABCDF

Stop when has_more is false.

Paginated endpoints

The following endpoints support cursor-based pagination:

GET /passes — List passes

GET /passes/{id}/providers — List providers for a pass

GET /providers — List wellness providers

GET /providers/{providerBranchId}/gym-copay-options — List gym co-pay options

GET /issuers — List approved issuers

GET /classes — List classes

GET /clients/{clientId}/bookings — List client bookings

GET /credit_packages — List credit packages

Sorting

Results are returned most-recent first (descending by creation time) unless otherwise noted in the endpoint's documentation.

Notes

Never use starting_after and ending_before in the same request.

limit is capped at 100. Values above 100 are rejected with a 400 validation error.

Cursor IDs are opaque — do not construct or modify them.

How it works#

List response envelope#

Paging through results#

Paginated endpoints#