These list API methods share a common structure, taking at least these three parameters: limit
, before
and after
.
Parameters
limit integer
A limit on the number of objects to be returned, between 1 and 50.
before string
A cursor for use in pagination. before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 50 objects, starting with obj_bar
, your subsequent call can include before=obj_bar
in order to fetch the previous page of the list.
after string
A cursor for use in pagination. after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 50 objects, ending with obj_foo
, your subsequent call can include after=obj_foo
in order to fetch the next page of the list.
Example
{
"data": [
{
"field": "value"
}
],
"paging": {
"before": null,
"after": "aWQ6YzYyZjViNTAtZTNiOS0xMWVjLTk0OWEtNjFkMjljNjZlMmNm"
}
}