Pagination

In order to make the REST API as easily usable as possible, we implemented paging functionality.

Query Parameters

On all REST APIs, that allow you to list objects, there are two optional query parameters which can be set:

JavaScript

{
  page: number, // default 1
  pageSize: number, // default 100
}

Using these query parameters you can efficiently navigate a large list of objects.

Response Parameters

To make it even easier, all our paginated response return three parameters which allow you to easily navigate to the first, next and last page:

JavaScript

{
  first_page 	: '/customers?page=1&pageSize=100',
  next_page  	: '/customers?page=2&pageSize=100',
  last_page  	: '/customers?page=10&pageSize=100',
	total				: number,
  count				: number,
  data				: [...]
}