Skip to main content

Pagination

All endpoints that return a list of items will return a paginated result.

{
  "total": 0,
  "per_page": 0,
  "current_page": 0,
  "last_page": 0,
  "result": [
    
  ]
}
FieldDescription
totalTotal number of results
per_pageNumber of items per page
current_pageCurrent page that is returned
last_pageLast page number
resultActual data

You can control how data are returned with the following query parameters:

  • page: page number to return (Default: 1)
  • per_page: number of items returned (Default: 20, Max: 100)

Example:

GET .../users?page=2&per_page=50

If you omit any of these parameters in the query the default value is used.