# GraphQL cursor pagination method ## Overview GraphQL cursor pagination is a method for paginating GraphQL APIs. In this context, a 'cursor' is a pointer that represents a specific position in the data set. Instead of saying *"return page 3"*, you say *"return 10 items after this cursor"*. {% hint style="info" %} You can find more information about how this pagination method works in [Shopify's API documentation](https://shopify.dev/docs/api/usage/pagination-graphql). {% endhint %} {% hint style="info" %} The GraphQL cursor pagination method was developed for the [Shopify GraphQL API](https://shopify.dev/docs/api/usage/pagination-graphql); however, the same principles apply to other GraphQL systems. {% endhint %} ## GraphQL cursor options

Option Summary

EndCursor path

Option	Summary
EndCursor path	The expected location of the pointer (i.e. the cursor) for the last item returned in the current page of results. When the next page is requested, the `EndCursor` is passed as the `after` argument, telling Shopify to start fetching from this point. The `EndCursor path` is always defined in the following form: `data.{type}.pageInfo.endCursor` Here, the `{type}` element should be replaced with the type that's defined by the schema - for example: `data.products.pageInfo.endCursor`
HasNextPage path	The expected location of the `HasNextpage` indicator. This is a boolean flag, indicating whether more pages exist after the current batch. If `HasNextPage` is `false`, then you’ve reached the end of the list, and no further requests are made. The `HasNextPage` path is always defined in the following form: `data.{type}.pageInfo.hasNextPage` Here, the `{type}` element should be replaced with the type that's defined by the schema - for example: `data.products.pageInfo.hasNextPage`

The expected location of the pointer (i.e. the cursor) for the last item returned in the current page of results. When the next page is requested, the EndCursor is passed as the after argument, telling Shopify to start fetching from this point.

The EndCursor path is always defined in the following form:

data.{type}.pageInfo.endCursor

Here, the {type} element should be replaced with the type that's defined by the schema - for example:

data.products.pageInfo.endCursor

HasNextPage path

The expected location of the HasNextpage indicator. This is a boolean flag, indicating whether more pages exist after the current batch. If HasNextPage is false, then you’ve reached the end of the list, and no further requests are made.

The HasNextPage path is always defined in the following form:

data.{type}.pageInfo.hasNextPage

Here, the {type} element should be replaced with the type that's defined by the schema - for example:

data.products.pageInfo.hasNextPage

## GraphQL cursor pagination - endpoint body requirements The GraphQL cursor pagination method works in conjunction with a query on the endpoint body, which determines required settings. For example: {% code overflow="wrap" %} ```graphql {"query":"{products(first: 250, {{pagination_cursor}}) {edges { node { id title } } pageInfo { hasNextPage startCursor endCursor }}}","variables":{}} ``` {% endcode %} If you need to change the existing query for an endpoint, you should [edit the connector ](/product-documentation/connectors-and-instances/working-with-connectors/updating-a-connector.md)and access [body options](/product-documentation/developer-hub/connector-builder/building-your-own-connector/4-endpoints/endpoint-options/body.md) for the required endpoint. ## When does pagination stop? Pagination continues until `hasNextPage` is returned as `false`. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.wearepatchworks.com/product-documentation/developer-hub/connector-builder/building-your-own-connector/4-endpoints/endpoint-options/pagination/graphql-cursor-pagination-method.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.