Pagination Object
Last updated
Last updated
A wrapper around a list of objects so they can be paginated over many requests. If an API endpoint might return a long list of values, it will return those values in a paginated form. The paginated data will have either a before
or after
value, and that value should be provided on the next API request to get the remaining values. For more information on pagination, see the pagination overview.
Key | Type | Value |
---|---|---|
count
int
The total number of values being paginated over.
data
array
The values on this page.
paging
object
An object containing a before
value and/or an after
value. One of these values should be provided on the next API request, depending on the direction you are paging.