Pagination

Pagination refers to the process of dividing a large set of data into smaller, more manageable pieces, or "pages", to make it easier to retrieve and display the data. Pagination allows to return a subset of data in response to a query, rather than returning all of the data at once.

Pagination is commonly used that return large amounts of data, such as search results or lists of items, to prevent overloading the client with too much data at once. Instead, the API returns a limited number of results, such as 10 or 20, along with information about the total number of results and the page number of the current results.

The client can use this information to request additional pages of data, such as the next 10 or 20 results, by passing a parameter indicating the desired page number. Pagination typically involves specifying a limit on the number of items returned per page, along with an offset to indicate the starting position for the current page of data.

Overall, pagination in API allows for more efficient data retrieval and a better user experience by breaking large datasets into smaller, more manageable chunks.

All resources in the Altruist Public API have support for fetching in bulk via the list methods.

We utilize a page-based system for listing items in bulk.

The Paging Object

Pagination Parameters

Field Name	Description
page number	Desired page number, default is 0.
page_size number	Desired number of entries per page, defaults is 100, max value is 1000.