Get Agent
phantombuster.get_agent
ActionBusiness appsconnection required
Calls the Phantombuster API with the connection's credentials.
Read one Phantom's record, with the URLs of its result files.
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
6 fields, 1 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_id The Phantom's numeric id, which its URL in the Phantombuster dashboard ends with. | string | Yes | — | — | 1234567890123456 |
with_manifest Also return the Phantom's manifest. | boolean | No | false | — | — |
with_agent_object Also return the agent object the Phantom's script persists between runs. | boolean | No | false | — | — |
with_code Also return the script's source code. | boolean | No | false | — | — |
with_slaves Also return the slave agents this Phantom launches. | boolean | No | false | — | — |
with_sub_slaves Also return slaves of those slaves. This only has an effect together with the slaves switch, and is not sent without it. | boolean | Conditional | false | only with with_slaves | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"agent_id": "1234567890123456",
"with_agent_object": false,
"with_code": false,
"with_manifest": false,
"with_slaves": false,
"with_sub_slaves": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
agent_id The Phantom that was read. | string | — |
agent The agent record as Phantombuster returned it. | object | — |
agent.s3Folder The Phantom's own storage folder, which the result URLs are built from. | string | — |
agent.orgS3Folder The org's storage folder, which the result URLs are built from. | string | — |
result_files Download URLs for the latest run's result files, derived from the two storage folders; empty when the Phantom has never run. | object | — |
result_files.csv The latest result.csv download URL. | string | — |
result_files.json The latest result.json download URL. | string | — |
{
"agent": {
"orgS3Folder": "",
"s3Folder": ""
},
"agent_id": "",
"result_files": {
"csv": "",
"json": ""
}
}Notes
- Phantombuster does not return the result files themselves: their URLs are built from the agent's two storage folders, which this node does for you.
- These URLs hold the LATEST run's results. For one specific run, use Get Container Result with that run's container id.
- 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 Get Agent 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.