Pagination

A resource which returns a list doesn't return all results at once. Instead, the number of results is constrained and you can traverse the results. For that purpose, the list requests accept the parameters max and offset.

Request Parameter

Default Value

Description

max

10

Maximal number of returned resources. Maximal allowed value is 100.

offset

0

The offset from the first result to list from.

All list responses return a number of total results in HTTP response header.

HTTP Response Header

Description

x-total-count

Number of total results.

An example which returns the 21st to 30th resource:

curl-H "Content-Type: application/json" -H "Authorization: Bearer {{OAUTH_TOKEN}}" https://api.amio.io/v1/channels?max=10&offset=20