Skip to main content
All endpoints that list objects provide support for cursor-based pagination. For instance, you can list workers, list charges or list payments. These endpoints share a common structure, returning items in reverse chronological order—the most recently created object appears first, and the oldest appears last.

Parameters

limit
integer
default:"10"
A limit on the number of objects to be returned, between 1 and 100.
cursor
string
A cursor for pagination. Pass the cursor value from a previous response to fetch the next page. Unlike starting_after and ending_before which accept object IDs, cursor should only be used with the cursor value returned by the list endpoint.
starting_after
string
An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects ending with item_12n4, your subsequent call can include starting_after=item_12n4 to fetch the next page.
ending_before
string
An object ID for backward pagination. For instance, if you make a list request and receive 100 objects starting with item_2d54, your subsequent call can include ending_before=item_2d54 to fetch the previous page.
Only one of cursor, starting_after, or ending_before may be provided per request. Providing more than one will result in an error.

Returns

cursor
string
A cursor for fetching the next page of results. This field is only present when there are more results to fetch. If the cursor field is absent from the response, you have reached the end of the list.