Pagination

All list endpoints offer pagination functionality and follow the same structure:

{
  "data": [
    {}
  ],
  "meta": {
    "links": {
      "first": "https://api.vzaar.com/api/v2/videos",
      "last": "https://api.vzaar.com/api/v2/videos?page=4",
      "next": "https://api.vzaar.com/api/v2/videos?page=2",
      "previous": null
    },
    "total_count": 4
  }
}

Pagination Links

The meta data object contains a list of links, including the first, last, next and previous pages.

A null value signifies that there is no pagination action available e.g. if you are on the first page, then previous will be null.

Page Size

vzaar provides default page sizes, typically 25 objects. For some endpoints this is configurable within specified limits. Please refer to the specific endpoints for more details.

Ordering and Filtering

Most API endpoints that return a list of resources also offer the ability to order and filter your results. Please refer to the specific endpoints for more details.

Total Count

The total_count value represents the total size of your resource collection e.g. a total_size value of 125 from a /videos response would mean you have 125 video.