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.

Anchor to How it worksHow 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. If applicable, then a response header returns links to the next page and the previous page of results. You can use the links in the response header to iterate through the pages of results.

Anchor to Link header syntaxLink header syntax

Link headers use the following syntax:

The link header includes a rel parameter that describes the relation of the linked page to the current page of results. The value can either be previous or 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.

Anchor to ParametersParameters

The URL in the link header can include the following parameters:

Anchor to Supported endpointsSupported endpoints

You can use cursor-based pagination on most REST Admin API GET endpoints that retrieve a list of resources.

If the REST resource includes the limit parameter on the GET endpoint, then you can use the endpoint to request paginated data. For example, the Customer resource includes the limit parameter on the GET endpoint that retrieves a list of customers.

Anchor to Make a request for paginated dataMake a request for paginated data

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 customers, with a limit of 3 customers 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 customers.

Anchor to Retrieve the next page of resultsRetrieve the next page of results

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 customers after the first page.

You can use the URLs in the link headers to iterate through each page of results. If you make a request to a page, and the response header only includes a link to the previous page, then you've reached the last page of results.

Anchor to Change the number of results for a specific pageChange 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 customers, 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 customers after the first page of results:

Anchor to Use the shopify-api npm libraryUse the shopify-api npm library

The @shopify/shopify-api library provides backend support for JavaScript and TypeScript apps to access the REST Admin API.

Anchor to ExampleExample

The following code retrieves customers from a store by fetching them in batches of 10 until all customers have been retrieved. You can store the pageInfo data between requests using a session.

Anchor to Limitations and considerationsLimitations and considerations

• A request that includes the page_info parameter can't include any other parameters except for limit and 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.
• The link header URLs are temporary and we don't recommend saving them to use later. Use link header URLs only while working with the request that generated them.
• Any request that sends the page parameter will return an error.