Skip to main content

Pagination

All API endpoints that return a collection of objects (ex. Warrants, Tenants, Users, Permissions and Roles) support pagination via limit and page query parameters:

GET /users?limit=2&page=2
ParameterDescriptionTypeRequired
limitA positive integer representing the max number of items to return in response.Query paramyes
pageA positive integer (starting with 1) representing the page of items to return in response. Used in conjunction with the limit param.Query paramyes

Request

curl "https://api.warrant.dev/v1/users?limit=2&page=2" \
-H "Authorization: ApiKey YOUR_KEY"

Response

[
{
"userId": "newUser2",
"email": "email2@userid.com"
},
{
"userId": "email@userid.com",
"email": null
}
]