Vizion's API list resources are paginated to allow consumers to traverse data over multiple requests.
Providing a paginated endpoint with the query parameter ?include_metadata=true
will modify the response. You will find response data under the "data"
key, and pagination information is located under the "metadata"
key:
{
"data": {...},
"metadata": {
"page": 1,
"page_count": 1,
"per_page": 25,
"item_count": 17
}
}
If a resource supports pagination, response examples with and without pagination can be found under "Example" for each endpoint.
🦉
Use pagination to retrieve all references
Open Recipe
Pagination query params
Field Name | Input | Description | Default |
---|---|---|---|
include_metadata | true or false | Return pagination information | false |
limit | Positive number | Specifies the count per page | 25 |
page | Positive number | Specifies the returned page | 1 |
Metadata object
Field Name | Type | Description |
---|---|---|
page | number | Current page number |
page_count | number | Total count of pages |
per_page | number | Results returned per page |
item_count | number | Total count of results |