Pagination

All GET endpoints that return a list use cursor-based pagination. Each response carries the page of items and a meta object with the cursors for the surrounding pages.

ARGUMENTS

Parameter	Description
`limit`	(optional) Number of results per request. Accepted values: 1 - 100. Default 50
`nextCursor`	(optional) Cursor returned in `meta.nextCursor` of the previous response. Returns the next page.
`prevCursor`	(optional) Cursor returned in `meta.prevCursor` of the previous response. Returns the previous page.

Results are in descending order (newest item first).

META

Field	Description
`limit`	Number of results requested for this page.
`nextCursor`	Cursor for the next page. Absent or `null` when there is no next page.
`prevCursor`	Cursor for the previous page. Absent or `null` on the first page.
`hasNextPage`	Boolean. Whether a next page exists.
`hasPreviousPage`	Boolean. Whether a previous page exists.

JSON

{
  "status": true,
  "message": "successfully fetched all beneficiaries",
  "data": {
    "data": [],
    "meta": {
      "limit": 50,
      "nextCursor": "eyJpZCI6IjQyYWE2ZDMwLWI1NGMtNGU4NC04MjJhLWM3NGQ5YWE1M2MwNCJ9",
      "prevCursor": null,
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

To walk a full list, repeat the request with nextCursor set to meta.nextCursor until hasNextPage is false. Cursors are opaque; do not construct or modify them.

OFFSET PAGINATION (COMPATIBILITY)

Integrations built on page numbers can append /offset to a list endpoint (for example /api/v2/customers/offset) to keep the legacy page/take parameters:

Parameter	Description
`take`	(optional) Number of results per request. Accepted values: 1 - 50. Default 10
`page`	(optional) Result page. Default 1
`order`	(optional) Result order. Accepted values: DESC (default), ASC

The meta object on /offset routes contains page, take, itemCount, pageCount, hasPreviousPage and hasNextPage. New integrations should use cursor pagination.

Rate Limiting IP Whitelisting