# REST GET

<!-- meta: type=api-rest-get; location=Connectors › API; category=Step (action); platforms=Joomla and WordPress (where applicable) -->

## Overview

Sends an HTTP GET request to an external API and returns the response into your flow.

When the flow reaches this step, JOrchestrator executes **REST GET** against your linked site or an external integration, using the field values you set on **General** and **Design**. Downstream steps can read the output payload fields defined for this node.

## Why use this node

REST GET is a **action step** in the **Connectors › API** group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.

Typical reasons teams add **REST GET** to a flow:

- Pull live data from a SaaS API before updating CMS content
- Fetch exchange rates, stock levels, or weather for dynamic emails
- Verify an external record still exists before deleting a local copy

## Example workflows

Common patterns on the canvas:

1. **Webhook** → **REST GET** → **Set JSON** → **Update Article**
2. **Scheduled trigger** → **REST GET** → **If** → **Send Email** on failure

## How to set it up

Enter the URL on the Design tab. Add headers or authentication (Bearer, Basic, or API key) when the service requires them.

## Good to know

GET requests do not send a request body. Use Check Condition on the status code to branch on success vs failure.

## Properties panel

The designer shows these tabs for this node:

| Tab | Purpose |
|-----|---------|
| **Info** | Plain-language description and output payload fields for downstream steps |
| **General** | Canvas label and read-only node ID |
| **AI** | Optional assistant to help draft settings from plain language |
| **Design** | Node-specific configuration fields |

### System (automatic — not edited by the user)

These fields are managed by the designer or runtime — you do not type into them directly:

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `_nodeId` | Node ID | `node-id` | No | — | — |
| `_payloadFields` | Available Fields | `payload-panel` | No | — | — |
| `headers` | Headers | `http-headers-builder` | No | — | Optional request headers. Authentication headers are added separately from the Authentication setting. |
| `body` | Request body | `raw-json-shape-editor` | No | `apiRestShowBody` | {
  "id": "{{node_0.id}}"
} |

### User-configured — General tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `label` | Label | `text` | No | — | Node label |

### User-configured — Design tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `url` | URL | `payload-text` | **Yes** | — | https://api.example.com/v1/resource |
| `authType` | Authentication | `select` (`none` \| `bearer` \| `basic` \| `api_key`; default: `none`) | No | — | Bearer, Basic, or API key header. Values support {{placeholders}} from upstream nodes. |
| `bearerToken` | Bearer token | `secret-text` | No | `authType === 'bearer'` | Bearer token or {{secrets.api_token}} |
| `basicUsername` | Basic auth username | `payload-text` | No | `authType === 'basic'` | Username |
| `basicPassword` | Basic auth password | `secret-text` | No | `authType === 'basic'` | Password or {{secrets.password}} |
| `apiKeyHeader` | API key header name | `text` (default: `X-API-Key`) | No | `authType === 'api_key'` | X-API-Key |
| `apiKeyValue` | API key value | `secret-text` | No | `authType === 'api_key'` | Key value or {{secrets.api_key}} |
| `requireHttps` | Require HTTPS | `toggle` (default: `true`) | No | — | Reject http:// URLs when enabled. |
| `timeoutSeconds` | Timeout (seconds) | `number` (default: `30`) | No | — | — |
| `responseFormat` | Parse response as | `select` (`json` \| `text`; default: `json`) | No | — | When json is selected, a parsed object is returned in the json field when the body is valid JSON. |

### CMS site configuration (not on this node's properties panel)

Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under **Node Configuration**, not per step on this node. Link the flow to a domain before testing CMS-backed fields.

## Output payload fields

After this step runs, later nodes can reference these fields using placeholders such as
`{{rest_get.success}}`.

| Field key | Type | Description |
|-----------|------|-------------|
| `success` | boolean | Whether the operation completed successfully. |
| `statusCode` | number | HTTP response status code (e.g. 200, 404). |
| `status` | number | HTTP status code or operation status string. |
| `statusText` | string | HTTP reason phrase (e.g. OK, Not Found). |
| `headers` | object | HTTP response headers as an object. |
| `body` | string | Raw HTTP response body as text. |
| `json` | object | Parsed JSON when the response body is valid JSON. |
| `method` | string | HTTP method used for the request. |
| `url` | string | Public HTTP URL to a resource on the site. |
| `message` | string | Human-readable status, error, or result summary. |

## Validation rules

- **URL** (`url`) must be filled before the flow can be saved.

## Related nodes

Other steps in the same area of the palette:

- **REST DELETE** (`api-rest-delete`) — Connectors › API
- **REST PATCH** (`api-rest-patch`) — Connectors › API
- **REST POST** (`api-rest-post`) — Connectors › API
- **REST PUT** (`api-rest-put`) — Connectors › API