# Pagination

The easyroam API uses pagination to limit the amount of data returned in a single request. This is done to prevent the API from returning too much data at once, which could lead to performance issues.
Most endpoints that return a list of items require pagination and are marked with Paginated and will always return the following additional fields in the response:

Field	Description
`offset`	The offset of the first item in the response
`limit`	The maximum number of items in the response
`total`	The total number of items available

They will also require you to provide the following parameters in the request in the json body:

Note

You must provide these parameters in the json formatted body of the request, not as query parameters. The content type of the request must be application/json.

Parameter	Description
`offset`	The offset of the first item in the response
`limit`	The maximum number of items in the response

Note

The offset parameter is zero-based, meaning that the first item in the response will be the offsetth item in the list of all items. For example, if you want to get the first 10 items, you would set offset to 0 and limit to 10. If you want to get the next 10 items, you would set offset to 10 and limit to 10.

For example, for a collection with a total of 45 results, and each page containing 20 items the parameters for each page would be as follows:

Page	Parameter values	# of items
1	`offset=0`, `limit=20`	20
2	`offset=20`, `limit=20`	20
3	`offset=40`, `limit=20`	5

Warning

The API will not return an error if you request a page that does not exist. Instead, it will return an empty list of items.