Make paginated requests to the REST Admin API
REST endpoints support cursor-based pagination. This guide illustrates how to request paginated data from the REST Admin API and access each page of results.
How it works
When you send a request to a REST endpoint that supports cursor-based pagination, the response body returns the first page of results, and a response header returns links to the next page and the previous page of results (if applicable). You can use the links in the response header to iterate through the pages of results.
Link headers use the following syntax:
The link header includes a
rel parameter, where
relation-types describes the relation of the linked page to the current page of results. The value can either be
next. If your initial request doesn't return enough records to generate an additional page of results, then the response won't have a link header.
The URL in the link header can include up to three parameters:
page_info: A unique ID used to access a certain page of results. The
page_infoparameter can't be modified and must be used exactly as it appears in the link header URL.
limit: The maximum number of results to show on the page.
fields: A comma-separated list of which fields to show in the results. This parameter only works for some endpoints.
A request that includes the
page_info parameter can't include any other parameters except for
fields (if it applies to the endpoint). If you want your results to be filtered by other parameters, then you need to include those parameters in the first request you make.
You can use cursor-based pagination on the following endpoints.
- Customer (search)
- GiftCards (search)
- ProductVariants (index)
Make a paginated request and iterate through the pages
When you make a request to an endpoint that supports paginated results, you can set the number of results to return per page using the
limit parameter. If you don't specify a
limit, then the endpoint will use its default page limit. You can also set other parameters in this request to narrow down your results.
The following example request asks the product endpoint for all products that belong to a collection, with a
limit of 3 products per page of results:
The response header returns a link header that includes a URL for the next page of results. The response body returns the first page of results, which includes 3 products.
To get the next page of results, you can make a request to the URL stored in the link header of the last response:
The response header includes a link to the previous page of results and a link to the next page. The response body includes the second page of results, which includes the next 3 products after the first page.
You can use the URLs in the link headers to iterate through each page of results. If you make a call to a page and the response header only includes a link to the previous page, then you've reached the last page of results.
Change the number of results for a specific page
You can change the
limit in a link header URL to return a different number of results from a specified point. For example, the following example request asks the product endpoint for all products, with a
limit parameter of 3:
If you change the
limit in the URL in the link header to 6 and make a request to that URL, then the response body returns the 6 products after the first page of results: