APIs that use marker-based paging use the
limit query parameters
to paginate through items in a collection.
Marker-based pagination is often used in cases where the length of the total set of items is either changing frequently, or where the total length might not be known upfront.
To fetch the first page of entries in a collection the API needs to be called
either without the
marker parameter, or with the
marker set to
limit parameter is optional.
curl https://api.box.com/2.0/folders/0/items?limit=100&usemarker=true \ -H "Authorization: Bearer ACCESS_TOKEN"
To fetch the next page of entries the API needs to be called with
marker parameter that equals value of the
next_marker value that was
received in the API response.
curl https://api.box.com/2.0/folders/0/items?marker=34332423&limit=100&usemarker=true \ -H "Authorization: Bearer ACCESS_TOKEN"
The final page of items has been requested when the next
next_marker value is
null in the response object. At this point there are no more items to fetch.
The following query parameters are used to paginate a collection.
|Integer||The first position in the collection to return results from. This should be a value that was returned in a previous request.|
|Integer||Depends on API||The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.|
|Boolean||An optional query parameter that can be used with API endpoints that support both types of pagination to select pagination type. Set to |
When paginating collections, the API returns an object that contains the set of results as an array, as well as some information about the current page of results.
|Array||The page of items for this page. This will be an empty array if there are no results.|
|Integer||The value that can be used as the |
|Integer||The limit used for this page of results. This will be the same as the |
Some endpoints that support offset-based pagination are: