Read file list
List the object keys under a prefix (or the given keys) as file references.
List the object keys under a prefix (or the given keys) as file references.
When to use it
List file references from a storage prefix or an explicit set of keys. The output identifies files for later steps; it does not extract their content. A filename selection belongs to the selected connection.
Add and configure
- Add Read file list from the workflow step picker.
- Give the step a recognisable name and connect its required inputs.
- Set the options below. Nested names identify fields within an object or a list item.
- Validate the recipe, inspect the test result, then run it on the intended data.
The step identifier used in the editor’s code view is object_list.
Settings
| Setting | Accepted value | Required | Default | What it controls |
|---|---|---|---|---|
Object Keys (object_keys) | list of string | No | Not specified | Explicit keys, or list the prefix when empty. |
Prefix (prefix) | string | No | "" | Select files under this prefix. |
Endpoint (source) | object | Yes | Not specified | Object-store connection to read. |
Catalog Slug (source.catalog_slug) | string or null | No | null | Catalog slug — mirrored for FE convenience (icon/label resolution). |
Connection Id (source.connection_id) | string; format uuid or null | No | null | UUID of the Connection (integration row). |
Display Name (source.display_name) | string or null | No | null | Human-readable label — the connection's display_name resolved server-side. |
EndpointKind (source.kind) | "connection" | No | "connection" | Source location type. Select the supported source and provide its corresponding connection or app location. |
Inputs and outputs
| Direction | Port | Content | Required | Multiple records |
|---|---|---|---|---|
| Inputs | in | files | Yes | Yes |
| Outputs | out | files | Yes | Yes |
Effects, testing, and recovery
Reads an external source.
The declared preview behaviour is to execute this step. Reads, processing, or model usage can therefore be real. Read dry runs before using a preview with live connections.
No duplicate-prevention key is declared for this step. Do not assume that manually repeating the step is free of repeated effects.
Example: Every file under a prefix of the platform store
Step settings:
{
"prefix": "invoices/",
"source": {
"catalog_slug": "platform_store",
"connection_id": "33333333-3333-4333-8333-333333333333"
}
}
Example: An explicit list of keys
Step settings:
{
"object_keys": [
"reports/q1.pdf",
"reports/q2.pdf"
],
"source": {
"catalog_slug": "s3_storage",
"connection_id": "55555555-5555-4555-8555-555555555555"
}
}
Check the result
Inspect the selected run’s status, counts, errors, and output records. An empty collection can be a valid result, and a completed step can contain per-record failures where the step defines that behaviour. Check the next step’s expected record shape before publishing or delivering the result.