Pagination | laravel-query-builder | Spatie

 SPATIE

  Laravel Query Builder
========================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-query-builder](https://spatie.be/docs/laravel-query-builder/v4)  Advanced-usage  Pagination

 Version   v7   v6   v5   v4   v3   v2

 Other versions for crawler [v7](https://spatie.be/docs/laravel-query-builder/v7) [v6](https://spatie.be/docs/laravel-query-builder/v6) [v5](https://spatie.be/docs/laravel-query-builder/v5) [v4](https://spatie.be/docs/laravel-query-builder/v4) [v3](https://spatie.be/docs/laravel-query-builder/v3) [v2](https://spatie.be/docs/laravel-query-builder/v2)

- [ Introduction ](https://spatie.be/docs/laravel-query-builder/v4/introduction)
- [ Requirements ](https://spatie.be/docs/laravel-query-builder/v4/requirements)
- [ About us ](https://spatie.be/docs/laravel-query-builder/v4/about-us)
- [ Installation & setup ](https://spatie.be/docs/laravel-query-builder/v4/installation-setup)
- [ Support us ](https://spatie.be/docs/laravel-query-builder/v4/support-us)
- [ Questions and issues ](https://spatie.be/docs/laravel-query-builder/v4/questions-issues)
- [ Changelog ](https://spatie.be/docs/laravel-query-builder/v4/changelog)

Features
--------

- [ Filtering ](https://spatie.be/docs/laravel-query-builder/v4/features/filtering)
- [ Sorting ](https://spatie.be/docs/laravel-query-builder/v4/features/sorting)
- [ Including relationships ](https://spatie.be/docs/laravel-query-builder/v4/features/including-relationships)
- [ Selecting fields ](https://spatie.be/docs/laravel-query-builder/v4/features/selecting-fields)
- [ Appending attributes ](https://spatie.be/docs/laravel-query-builder/v4/features/appending-attributes)

Advanced usage
--------------

- [ Extending query builder ](https://spatie.be/docs/laravel-query-builder/v4/advanced-usage/extending-query-builder)
- [ Pagination ](https://spatie.be/docs/laravel-query-builder/v4/advanced-usage/pagination)
- [ Front-end implementation ](https://spatie.be/docs/laravel-query-builder/v4/advanced-usage/front-end-implementation)
- [ Multi value delimiter ](https://spatie.be/docs/laravel-query-builder/v4/advanced-usage/multi-value-delimiter)

      You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command:

 `                                    composer show spatie/laravel-query-builder                                                                                                                                                                                                                                    `

Pagination
==========

###  On this page

1. [ Adding Parameters to Pagination ](#content-adding-parameters-to-pagination)

This package doesn't provide any methods to help you paginate responses. However as documented above you can use Laravel's default [`paginate()` method](https://laravel.com/docs/5.5/pagination).

If you want to completely adhere to the JSON API specification you can also use our own [spatie/json-api-paginate](https://github.com/spatie/laravel-json-api-paginate)!

Adding Parameters to Pagination
-----------------------------------------------------------------------------------------------------------------------------------------------------

By default the query parameters wont be added to the pagination json. You can append the request query to the pagination json by using the `appends` method available on the [LengthAwarePaginator](https://laravel.com/api/6.x/Illuminate/Contracts/Pagination/LengthAwarePaginator.html#method_appends).

```
$users = QueryBuilder::for(User::class)
    ->allowedFilters(['name', 'email'])
    ->paginate()
    ->appends(request()->query());
```