Initial Request(No cursor, limit=50)
Server Response(Data + next_cursor="abc")
Next Request(cursor="abc", limit=50)
Server Response(Data + next_cursor="xyz")
Repeat using latest next_cursor...
Final Response(Data + next_cursor=null)
End of List
;
};
Most "list" endpoints in the Bluerails API (like listing accounts, payments, or payouts) return results in chunks, or "pages," rather than all at once. This prevents overly large responses and allows you to fetch data incrementally. We use **cursor-based pagination**.
## How Cursor Pagination Works
Instead of traditional page numbers, cursor pagination uses an opaque `cursor` string that points to a specific item in the dataset. To get the next page of results, you provide the `cursor` received from the previous response.
**Query Parameters:**
You control pagination using these query parameters on list endpoints:
* `limit` (optional, integer):
* Specifies the maximum number of items to return per page.
* Default: `25`
* Maximum: `100`
* `cursor` (optional, string):
* The cursor string obtained from the `next_cursor` field of the *previous* page's response.
* **Omit this parameter entirely for the very first request** to get the beginning of the list.
**Response Body:**
Paginated list endpoints return a JSON object with the following structure: