📚 Pagination

When accessing endpoints that yield a substantial volume of data, our API imposes an automatic limitation on the number of items returned in the response. This restriction serves as a standard safety measure to alleviate the load on our servers.

Our API uses cursor-based pagination, unlike traditional page-based methods that rely on page numbers and limits (like "page 1, page 2, page 3"), cursor-based pagination uses a unique identifier, a.k.a cursor/token, to keep track of the current position in the dataset. Each paginated response will then include a next cursor until there is no more data to scroll.

Pagination data is embedded into the "meta" JSON property within each response body. This data includes cursor values as well as convenient links, enabling navigation without the need for manual URI computation on your part.

{
  "data": [],
  "meta": {
    "paging": {
      "cursors": {
        "after": "dHJ4LTJXTFhiOGJQNnNTN1FSdkE2QUZHcDdOaEdzNw=="
      },
      "next": "https://rest.sandbox.rafiki-api.com/v1/payouts?paging_after=dHJ4LTJXTFhiOGJQNnNTN1FSdkE2QUZHcDdOaEdzNw%3D%3D&paging_limit=10"
    }  
  }
}