Paginated GET endpoints only return a subset of the results in the first response. You must execute subsequent requests to the endpoint with updated pagination parameters in order to get the rest of the data. This functionality is important to limit the size of the response for API endpoints that could theoretically return a large number of results.
How does pagination work in the Verkada API?
A pagination endpoint in the API accepts two special query parameters:
| Parameter | Type | Description |
|---|---|---|
| page_size | Integer | The number of items returned in a single response. Default is 100. Max is 200. |
| page_token | String | The pagination token used to fetch the next page of results. |
A pagination endpoint in the API will return a special response field:
| Parameter | Type | Description |
|---|---|---|
| next_page_token | String | The pagination token used to fetch the next page of results. |
If a non null value is returned for next_page_token, then the subsequent result needs to pass the value from next_page_token to page_token to receive the next page of results.
If a null value is returned for next_page_token, then the request can be considered complete and the user has received all results for the paginated endpoint.
Paginating through all results
This method of pagination is used to iterate through a result set until all results have been fetched, not to directly go to page X of the results. This is not possible.