Pagination

Every index endpoint returns paginated data. This data can be mutated by using Eager Loading or Partial Data. Check out the documentation on how to use those to get only the needed fields.

Paginate

An index request always returns the following structure:

Pagination

The maximum limit is 100, the api will never return more items even if you pass a limit higher than 100.

With limit, total and offset you can create your own pagination system.

To get the amount of pages: Math.ceil(total / limit);

To get the offset for a specific page; use limit * (page - 1);

To get all items make a loop like this

while (total > offset + limit) { fetch(offset); offset += limit; }

A more elaborate example using axios in javascript (assuming you have the bearer token and the base url in Axios defaults)

Offset pagination can result in data not being fetched or being fetched twice.
For example: Someone is adding a resource which should be showing up in page 1, but you are already fetching page 2. Page 1 just became bigger by one, so page 2 will see the last item of page 1 at the top of the list again.

Eventually we will add a Continuation Token to fix this problem.

Paginate#

Paginate