Pagination
All endpoints that list objects provide support for pagination. For instance, you can list athletes, list programs or list results.
These endpoints share a common structure using cursor-based pagination, taking at least these three parameters: limit
, after_cursor
and before_cursor
.
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
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
A cursor for use in pagination. after_cursor
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
after_cursor=obj_foo
in order to fetch the next page of the list.
A cursor for use in pagination. before_cursor
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
before_cursor=obj_bar
in order to fetch the previous page of the list.