# FTP List

<!-- meta: type=ftp-list; location=Connectors › FTP; category=Step (action); platforms=Joomla and WordPress (where applicable) -->

## Overview

Lists files in a remote FTP directory when the flow runs. Use as the first step in poll-and-process pipelines that ingest partner file drops.

When the flow reaches this step, JOrchestrator executes **FTP List** 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

FTP List is a **action step** in the **Connectors › FTP** 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 **FTP List** to a flow:

- Poll an FTP folder for new files to drive an Iterator loop
- Inventory remote files before selective download or delete steps
- Verify expected filenames exist before triggering import flows

## Example workflows

Common patterns on the canvas:

1. **Trigger or Webhook** → upstream steps → **FTP List** → **Send Email** or CMS update
2. **Scheduled trigger** → **FTP List** → **Debug** (while testing) → production action

## How to set it up

Enter host, credentials, and optional remote directory on the Design tab.

## Good to know

Returns files[] with name, type, size, and date for each entry — wire an Iterator to process each file.

## 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 | — | — |

### 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 |
|--------------|-------|------|----------|--------------|-------|
| `host` | Host | `payload-text` | **Yes** | — | ftp.example.com |
| `port` | Port | `payload-text` | No | — | 21 Default FTP port is 21. |
| `username` | Username | `payload-text` | **Yes** | — | Username or {{secrets.ftp_user}} |
| `password` | Password | `secret-text` | **Yes** | — | Password or {{secrets.ftp_pass}} |
| `timeoutSeconds` | Timeout (seconds) | `number` (default: `30`) | No | — | — |
| `passiveMode` | Passive mode | `toggle` (default: `true`) | No | — | Recommended for most firewalls. Data transfers use passive mode by default. |
| `remotePath` | Remote directory | `payload-text` | No | — | . or /uploads/ Directory to list. Use . for the login directory. |
| `maxFiles` | Max files | `select` (`100` \| `500` \| `1000` \| `2500` \| `5000` \| `10000`; default: `1000`) | No | — | — |

### 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
`{{ftp_list.success}}`.

| Field key | Type | Description |
|-----------|------|-------------|
| `success` | boolean | Whether the operation completed successfully. |
| `host` | string | Text value from this node's output. |
| `remotePath` | string | Text value from this node's output. |
| `count` | number | Number of items in the result set. |
| `files` | array | Array of file entries with name, type, size, and date. |
| `names` | array | Flat array of file names in the directory. |
| `message` | string | Human-readable status, error, or result summary. |

## Validation rules

- **Host** (`host`) must be filled before the flow can be saved.
- **Username** (`username`) must be filled before the flow can be saved.
- **Password** (`password`) must be filled before the flow can be saved.

## Related nodes

Other steps in the same area of the palette:

- **FTP Delete** (`ftp-delete`) — Connectors › FTP
- **FTP Download** (`ftp-download`) — Connectors › FTP
- **FTP Upload** (`ftp-upload`) — Connectors › FTP