soap_paginated_request

Input

Field	Description	Type	Required
`args`	Request parameters to send as query, body, or header values.	object[]	No
`authorization`	Overrides the connector’s default authentication for this request.	union	No
`baseUrl`	Overrides the connector’s base URL for the SOAP service.	string	No
`cursor`	Pagination position carried over from the previous page request.	object	No
`customErrors`	Remaps matching provider error responses to different statuses or messages.	object[]	No
`encodeQueryParams`	Whether to URL-encode query parameter values before sending.	boolean	No
`envelope`	SOAP envelope template, as a string or object, used to build the request body.	union	No
`iterator`	Controls how subsequent pages are requested.	object	Yes
`method`	HTTP method to use for the SOAP call, typically post. Allowed: `get`, `post`, `put`, `delete`, `patch`	enum	Yes
`namespaces`	XML namespace declarations added to the SOAP envelope.	object[]	No
`response`	Controls how each page response is parsed and paginated.	object	No
`soapAction`	Value sent in the SOAPAction HTTP header.	string	No
`soapOperation`	Name of the SOAP operation to invoke.	string	No
`url`	SOAP endpoint path appended to the base URL.	string	Yes
`useSoapContext`	Whether to wrap the request using the SOAP context. Default: `true`	boolean	Yes

args

Request parameters to send as query, body, or header values.

Field	Description	Type	Required
`arrayFormat`	How array values are serialized in the query string: repeat, brackets, comma, or stringify. Allowed: `repeat`, `brackets`, `comma`, `stringify`	enum	No
`condition`	A JEXL expression that includes the parameter only when it evaluates true.	string	No
`in`	Where to send the parameter: query, body, or headers. Allowed: `query`, `body`, `headers`	enum	Yes
`name`	Name of the request parameter.	string	Yes
`value`	Value of the parameter. Supports expressions.	any	Yes

authorization

Overrides the connector’s default authentication for this request.

none
basic
bearer
oauth2

Field	Description	Type	Required
`type`	Selects no authentication.	string	Yes

Field	Description	Type	Required
`encoding`	Encoding applied to the username and password, such as base64.	string	No
`password`	Password for basic authentication.	string	No
`type`	Selects HTTP basic authentication.	string	Yes
`username`	Username for basic authentication.	string	No

Field	Description	Type	Required
`includeBearer`	Whether to prefix the token with `Bearer` in the header. Defaults to true. Default: `true`	boolean	Yes
`token`	Bearer token sent with the request.	string	Yes
`type`	Selects bearer token authentication.	string	Yes

Field	Description	Type	Required
`includeBearer`	Whether to prefix the token with `Bearer` in the header. Defaults to true. Default: `true`	boolean	Yes
`token`	OAuth 2.0 access token sent with the request.	string	Yes
`type`	Selects OAuth 2.0 authentication.	string	Yes

cursor

Pagination position carried over from the previous page request.

Field	Description	Type	Required
`position`	How far into the previous page was read, so this request resumes from there.	union	No
`token`	Cursor token from the previous page used to fetch the next one.	union	No

customErrors

Remaps provider error responses to different statuses or messages. Useful for GraphQL APIs that return errors with a 200 status, normalizing provider-specific error formats, and giving AI agents clearer error messages.

Field	Description	Type	Required
`condition`	A JEXL expression that applies the remap only when it evaluates true.	string	No
`message`	Error message to return in place of the provider’s.	string	No
`receivedStatus`	Provider HTTP status code to match.	number	Yes
`targetStatus`	HTTP status code to return in place of the matched one.	number	Yes

iterator

Controls how subsequent pages are requested.

Field	Description	Type	Required
`in`	Where the pagination field is sent: query or body. Allowed: `query`, `body`	enum	Yes
`key`	Request field name that carries the page token or number.	string	Yes

namespaces

XML namespace declarations added to the SOAP envelope.

Field	Description	Type	Required
`namespace`	Namespace URI bound to the prefix.	string	Yes
`namespaceIdentifier`	XML namespace prefix.	string	Yes

response

Controls how each page response is parsed and paginated.

Field	Description	Type	Required
`collection`	Currently not in use.	boolean	No
`dataKey`	Path to the records array within the response.	string	No
`indexField`	Field used to key results when returning an indexed map.	string	No
`nextKey`	Path to the next-page token or cursor in the response.	string	No
`nextKeyIn`	Where the next-page token is read from: the response data or headers. Allowed: `data`, `headers`	enum	No

Output

Field	Description	Type	Required
`data`	Records accumulated across the fetched pages.	any	No
`message`	Status or error message from the response.	string	No
`next`	Cursor token for the next page. Null means the next request continues from `position` in the current page, and it is omitted when no pages remain.	union	No
`position`	How far into the current page has been read, saved in the cursor so the next request resumes from there.	number	No
`raw`	The raw provider response before parsing.	any	No
`statusCode`	HTTP status code of the provider response.	number	Yes

​Input

​Output

Input

Output