List Agents
phantombuster.list_agents
ActionBusiness appsconnection required
Calls the Phantombuster API with the connection's credentials.
List the Phantoms in the workspace, or just the ones named.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Phantombuster
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- org_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
agent_ids Return only these Phantom ids. Leave empty for every Phantom in the workspace. | array | No | — | array of string | ["1234567890123456"] |
with_argument Also return each Phantom's saved launch options. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"agent_ids": [
"1234567890123456"
],
"with_argument": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
agents The Phantoms, as Phantombuster returned them. | array | — |
count How many Phantoms came back. | number | — |
{
"agents": [],
"count": 0
}Notes
- The org this acts for comes from the connection's optional org_id, sent as the X-Phantombuster-Org header; leave it unset when the key already names one org.
Related Phantombuster nodes
See List Agents run in a workflow.
In a technical demo we add the Phantombuster connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.