Paging

Paging

Some resources (for example airports and cities) are too large to return the entire dataset in one response. The API will return the first page of results and links to subsequent pages. The desired page size and starting point can be specified as query parameters. The maximum page size is 100.

Query Parameter Description Default
limit The number of items to return (the page size) 20
offset The index of the item with which this result set should begin 0 (the first item)

Examples

Code snippet: Call

GET /references/countries?limit=10
GET /references/cities?limit=25&offset=50

The response will contain links to the first page, last page, next page and previous page. The links are calculated using the page size that was applied for this response.