Pagination allows you to efficiently manage and retrieve data.

Pagination is applied to all requests in the UserOperations API, allowing you to efficiently manage and retrieve data in smaller chunks. When you make an API request, you can expect to see a metadata key in the response body containing relevant pagination parameters.

The metadata object

Here's a brief description of each field in the metadata object for pagination:

pageThe current page number being displayed.
limitThe number of records displayed per page.
totalRecordsThe total number of records available in the dataset.
totalPagesThe total number of pages available based on the given "limit".
linkA URL to the next page of results. null will be returned if it is the last page.

To customize the number of records returned per page, you can adjust the limit parameter. The maximum limit is 100 records per page, while the default is 25.