The API Call node makes an HTTP request to any external API. You control the method, headers, query parameters, body, and authentication, and the node can retry on failure, extract a value with JSONPath, and cache the response.
What it does
- Sends GET, POST, PUT, DELETE, PATCH, HEAD, or OPTIONS requests.
- Authenticates with none, basic, bearer, or API key.
- Retries failed requests and caches responses to save calls.
- Pulls a specific value out of the response with a JSONPath expression.
Configuration reference
| Field | Required | What it does |
|---|---|---|
| URL | Yes | The endpoint to call. Supports variable tags. |
| Method | Yes | The HTTP method. Defaults to GET. |
| Headers | No | Header name and value pairs. Values support variable tags. |
| Query params | No | Key and value pairs added to the URL. |
| Body | No | The request body as text or JSON. Supports variable tags. |
| Auth | No | Authentication type and settings: none, basic, bearer, or apiKey. |
| Response config | No | Timeout, retry count from 0 to 5, JSONPath extraction, and response caching with a cache time. |
Named outputs
The node exposes four named outputs you can reference downstream:
[[status] from <id>]the HTTP status code[[headers] from <id>]the response headers[[data] from <id>]the parsed response body, with nested access like[[data.items] from <id>][[extractedData] from <id>]the JSONPath result
Plain [Input from <id>] returns the whole response. See Data flow and variables.
Local or Cloud, and cost
API Call runs in both Local and Cloud modes and costs 1 credit per run.
Worked example: fetch data with a bearer token
- Set the URL to
https://api.example.com/v1/itemsand the method to GET. - Set auth type to bearer and the token to
[[apiKey] from trigger-1]. - Reference the results downstream as
[[data] from apiCall-1].
Related
- Connect an App for connected app actions instead of raw HTTP
- Webhook Output
- Data flow and variables
Was this helpful?
Contact us