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.

Pagination query params

Field NameInputDescriptionDefault
include_metadatatrue or falseReturn pagination informationfalse
limitPositive numberSpecifies the count per page25
pagePositive numberSpecifies the returned page1

Metadata object

Field NameTypeDescription
pagenumberCurrent page number
page_countnumberTotal count of pages
per_pagenumberResults returned per page
item_countnumberTotal count of results