Pagination
Convoy’s API uses cursor-based pagination through the next_page_cursor
and
prev_page_cursor
parameters. Both parameters accept an existing object ID value
and return objects in reverse chronological order. The prev_page_cursor
parameter
returns objects listed before the named object. The next_page_cursor
parameter
returns objects listed after the named object.
These parameters are mutually exclusive. You can use either the next_page_cursor
or prev_page_cursor
parameter, but not both simultaneously. Full description of
each parameter is described below.
Parameters
Number of objects per response.
A cursor to use in pagination. It specifies your current place in the list and is used to query the next page.
A cursor to use in pagination. It specifies your current place in the list and is used to query the previous page.
Was this page helpful?