Skip to main content
Executes an HTTP request and gets items from an external endpoint one by one, with optional pagination. For each item that reaches it, this step calls an external web service, reads the response, and passes on the result as one or more items. It can follow pagination to keep requesting further pages and hand back the items from every page one by one, which makes it well suited to pulling lists of records such as products, orders, or customers out of an API. The values from the incoming item are available as placeholders, so the request can be tailored per item.

Fields

The Request group describes the call to make.

Sample data

This step calls an external service for each item passing through a route, so it runs as part of a route rather than on its own. A configuration that fetches an orders list with a GET request looks like this:
FieldValue
Request MethodGET
Request URI/orders
With this configuration, the step calls the orders endpoint and, with the Response parser set to read the orders list from the reply, emits each order as its own item. Turning on Add HTTP status to the response would instead wrap each item so its data sits under a data key with the status under httpStatus.