Pagination

Introduction

Fetching all objects of a resource can be convenient, but returning too many objects at once can be a heavy performance request. For this reason, base lists can be paginated and limits can be appended to includes in the URL when performing a SINGLE or LIST request.

URL Parameter

Pagination can be appended to the URL when performing a LIST request:

https://api.bundeling.com/V2/?page_size=3&page=2

Limits and pagination can be appended to the includes in the URL with a colon when performing a SINGLE or LIST request:

https://api.bundeling.com/V2/?include=foo:limit(10)

https://api.bundeling.com/V2/?include=foo:limit(10|5)

Pagination

To paginate the base list, you can append the URL with page_size and page.

Appending ?page_size=3 to the URL will retrieve a list of three items per page.
Appending ?page_size=3&page=2 to the URL will retrieve a list of items 4 to 6.

Limit

With the limit parameter, you can specify how many results should be retrieved per page. By appending a pipe (|) to the limit, you can retrieve an offset of the requested items.

Appending :limit(10) to the include of the URL will retrieve the first 10 items.
Appending :limit(10|3) to the include of the URL will retrieve items 21 to 30.