Log In

Pagination

When querying for lists of items, the responses will be paginated. The pagination will be represented in the links key of the response.

"links":{
  "self": "https://api.vantage.sh/v2/folders?page=2",
  "first": "https://api.vantage.sh/v2/folders?page=1",
  "next": "https://api.vantage.sh/v2/folders?page3",
  "last": "https://api.vantage.sh/v2/folders?page=5",
  "prev": "https://api.vantage.sh/v2/folders?page=1"
}
KeySescription
selfThe URL to the current page.
firstThe URL to the first page of items.
nextThe URL to the next page of items.
lastThe URL to the very last page of items.
prevThe URL to the previous page of items.

The Array of items will be available as a key that matches the name of the route. For instance, folders will have a top-level folders key.

{
  "links": {},
  "folders":[]
}

You can specify the page you want to access and the number of items per page by using the page and limit query params.

curl --request GET \
  --url https://api.vantage.sh/v2/folders?page=3&limit=10 \
  --header 'Accept: application/json'