For pagination apiato uses the L5 Repository Package and the
pagination gets applied whenever you use the
paginate function on any model repository
$stores = $this->storeRepository->paginate();).
.env file and set a number for
This is used in the
config/repository.php which is the config file of the L5 Repository Package.
?limit= parameter can be applied to define, how many results should be returned on one page (see also
This would return 100 resources within one page of the result. Of course, the
page query parameter can be
combined in order to get the next 100 resources:
In order to allow clients to request all data that matches their criteria (e.g., search-criteria) and disable pagination,
you can manually override the
$allowDisablePagination property in your specific
Repository class. A requester can then
get all data (with no pagination applied) by requesting
api.domain.test/endpoint?limit=0. This will return all matching
You can allow developers to skip the pagination limit as follows:
First, you need to enable that feature from the server by setting
Second, inform the developers (users) to pass
?limit=0 with the request they wish to get all it's data un-paginated.