Skip to main content
Vindicia Knowledge Center

Pagination

Pagination

All GET endpoints which return an object list support cursor based pagination with pagination information inside a pagination object. This means that to get all objects, you need to paginate through the results by always using the id of the last resource in the list as a starting_after parameter for the next call. To make it easier, the API will assign the next call into next attribute together with all the currently used pagination parameters. You know that you have paginated all the results when the return is empty (Next value will be undefined, as well). Using cursor-based pagination protects against the situation when the resulting object list changes during pagination (new resource gets added or removed).

The default limit is set to 20 but values up to 100 are permitted.

Parameter Description
limit - optional A limit on the number of objects to be returned, between 1 and 100.
starting_after - optional A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
ending_before - optional A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • cURL
  • Java
 
 

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top