title: Pagination
source_url: /developer-api/v1/pagination
summary: Pagination allows you to retrieve an entire dataset with a series of requests, where each request fetches a portion of the data set. By loading data in smaller chunks, pagination reduces the amount of data transmitted per response and alleviates the load on the servers, ensuring faster loading times and a smoother user experience.

content:
Pagination allows you to retrieve an entire dataset with a series of requests, where each request fetches a portion of the data set. By loading data in smaller chunks, pagination reduces the amount of data transmitted per response and alleviates the load on the servers, ensuring faster loading times and a smoother user experience.

Ramp API uses a mechanism called keyset pagination to divide data into fixed-size pages. Keyset pagination relies on the use of one or more columns with unique, ordered values in the database table. These columns are typically indexed for fast retrieval.

How keyset pagination works

Here's how keyset pagination works step-by-step:

To start, initiate a request for the first page of results. The API response will include a next field, which contains the complete URL for accessing the next page of data.

Use the complete URL in the next field to request the next page. The URL includes the start cursor and preserves the other query parameters required for the current result set. Treat the cursor as opaque instead of constructing or changing it yourself.

Repeat the process of requesting subsequent pages using the next URL and updating the start cursor parameter until the API returns a null value for the next field. This indicates that all records have been successfully fetched.

For endpoints that support the standard page_size parameter, the default page size is 20 and the maximum is 100. Check the specification for the endpoint before you assume it uses the standard pagination contract.