Pagination

GET requests that return a list of objects may support pagination. Pagination is based on a page number and not a cursor. When making a request, append page and limit parameters to the request to return a specific page of a specific size. Both parameters must be specified in order to return paginated data.

Parameter

Description

Type

page

Page number to return

Integer

limit

Number of items to return

Integer

For example:

curl -H 'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/?page=1&limit=10

Foxpass's API will return the following page object along with these items:

Parameter

Description

Type

page

Page number returned

Integer

limit

Number of items returned

Integer

next

Whether or not more items exist in the next page

Boolean

For example:

{"status": "ok", "data": [...], "page": {"page": 1, "limit": 10, "next": true}}

If both page parameters are not sent, Foxpass will return a null object instead of a full page object.