I'm working with Airbyte for the first time and trying to build pagination into a GraphQL request where the cursor needs to be passed into the GraphQL body. I can see lots of great examples of pagination in the request but not as much for injecting it into the GraphQL body. Is there some documentation I've missed?

Yes, Airbyte does support injecting pagination cursors into the body of a GraphQL request, and there is documentation covering this scenario. To inject a cursor (or any value) into a nested field in the JSON body of a GraphQL request, you should use the

request_body_json

option in the

request_options_provider

. For GraphQL, this is typically done by specifying a

field_path

that points to the nested location (such as

variables.after

for a cursor). Here’s how you can configure it:

yaml requester:   type: HttpRequester   url_base: "<https://your.graphql.api/>"   http_method: "POST"   request_options_provider:     request_body_json:       query: "query($after: String) { users(after: $after) { id name } }"       variables:         after: "{{ next_page_token }}"

Or, using the more advanced

RequestOption

component for nested injection:

yaml page_cursor_option:   request_option:     type: RequestOption     inject_into: body_json     field_path:       - variables       - after

This configuration ensures that the cursor value (e.g.,

next_page_token

) is injected into the correct place in the GraphQL request body. The documentation also notes that nested key injection is only available for

body_json

injection, and the

field_path

property is specifically designed for this use case. The

field_name

property is being deprecated in favor of

field_path

for future compatibility. You can find more details and examples in the official Airbyte documentation on [Request Options Provider](https://docs.airbyte.com/platform/connector-development/config-based/understanding-the-yaml-file/request-options#request-options-provider) and specifically the section on GraphQL request injection, which demonstrates how to inject values into nested fields in the request body for GraphQL queries. This should cover your use case for paginating GraphQL APIs with Airbyte. If you need to use a dynamic cursor value (e.g., from the previous response), you would use a Jinja expression like

{{ next_page_token }}

or

{{ last_records[-1]['cursor'] }}

as appropriate for your API and pagination strategy. For more on pagination strategies and cursor extraction, see the [pagination documentation](https://docs.airbyte.com/platform/connector-development/connector-builder-ui/pagination#cursor-pagination) as well. Summary: - Use

request_body_json

with

field_path

for nested GraphQL variables. - Inject the cursor using Jinja expressions. - See the linked documentation for detailed examples and schema references. [Request Options Provider (GraphQL injection)](https://docs.airbyte.com/platform/connector-development/config-based/understanding-the-yaml-file/request-options#request-options-provider) [Pagination in Connector Builder UI](https://docs.airbyte.com/platform/connector-development/connector-builder-ui/pagination#cursor-pagination)

@kapa.ai You're answer suggests the use of the

next_page_token

. Is that derived from the cursor_value of the CursorPagination pagination_strategy?

A message from kapa.ai

@kapa.ai Is there a way to use page_size too?

A message from kapa.ai