All endpoints that list objects provide support for pagination. For instance, you can list workers, list charges or list payments.

These endpoints share a common structure using cursor-based pagination, taking at least these three parameters: limit, start_after and ending_before.

All list API methods return items in reverse chronological order, such that the most recently created object will be returned first on the list and the oldest will be returned last.

​
Parameters

limit
integer
default: "10"

A limit on the number of objects to be returned, between 1 and 100.

starting_after
string

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
string

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.

Was this page helpful?

AuthenticationIdempotency