Connectors
REST API
Calls a REST endpoint and turns the JSON it returns into rows.
When to use it
Use it when a system offers an HTTP API rather than a file or a database, and you want its records in a pipeline alongside everything else.
In a pipeline
REST APISelect ColumnsExport JSON
Settings
| Setting | Type | Required | Default or hint |
|---|---|---|---|
| URL | text | Yes | https://api.example.com/data |
| Method | select | — | GET |
| Headers (JSON) | textarea | — | { "Authorization": "Bearer token", "Accept": "application/json" } |
| Request Body (JSON) | textarea | — | { "key": "value" } |
| Response Data Path | text | — | e.g. data.items or results |
Example
Fetching a list of orders from an API
- URL=https://api.example.com/v1/orders
- Method=GET
- Response Data Path=data.items
| JSON |
|---|
| { "data": { "items": [ { "id": "A-1041", "total": 120 }, { "id": "A-1042", "total": 80 } ] } } |
| id | total |
|---|---|
| A-1041 | 120 |
| A-1042 | 80 |
Response Data Path walks the dotted path and turns the array it finds there into rows.
Worth knowing
- If Response Data Path does not land on an array, the whole response becomes a single row — check the path whenever you get one row you did not expect.
- Only the top level of each item becomes columns; a nested object stays inside one cell.
- Headers (JSON) must be a valid JSON object, and a non-JSON response fails with a clear message.
- Request Body is sent only for POST, PUT and PATCH; requests to private addresses are blocked and responses over 20 MB are refused.