← Tools Reference

PhantomBuster

PhantomBuster integration (Developer Tools, Data). Imported from open-connector.

API key7 toolshttps://api.phantombuster.com/api/v2
GET
phantombuster_get_current_organization
Get the current Phantombuster organization for the connected API key.

/orgs/fetch

GET
phantombuster_list_agents
List all Phantombuster agents in the current organization.

/agents/fetch-all

GET
phantombuster_get_agent
Get a Phantombuster agent by ID.

/agents/fetch

1 parameter
ParamTypeRequiredDescription
idstringoptionalThe Phantombuster record ID.
POST
phantombuster_launch_agent
Add a Phantombuster agent to the launch queue.

/agents/launch

11 parameters
ParamTypeRequiredDescription
idstringrequiredThe Phantombuster record ID.
argumentstringoptionalAgent launch argument as a JSON string or plain object.
argumentsstringoptionalAgent launch argument as a JSON string or plain object.
bonusArgumentstringoptionalAgent launch argument as a JSON string or plain object.
saveArgumentbooleanoptionalWhether to save argument as the agent default launch options.
saveArgumentsbooleanoptionalWhether to save argument as the agent default launch options.
manualLaunchbooleanoptionalWhether the launch should be considered manually triggered.
maxInstanceCountintegeroptionalOnly launch if already running instances are below this value.
internalMetadataobjectoptionalKey-value metadata attached to the launched container.
userCustomMetadataobjectoptionalKey-value user metadata attached to the launched container.
persistedVolumeKeystringoptional
POST
phantombuster_stop_agent
Stop a Phantombuster agent.

/agents/stop

5 parameters
ParamTypeRequiredDescription
idstringrequiredThe Phantombuster record ID.
softAbortbooleanoptionalWhether to try a soft abort.
cascadeToAllSlavesbooleanoptionalWhether to recursively stop slave agents.
dontLaunchSoonbooleanoptionalWhether to disable the next scheduled launch-soon run.
switchToManualLaunchbooleanoptionalWhether to switch the agent to manual launch.
GET
phantombuster_list_containers
List containers associated with a Phantombuster agent.

/containers/fetch-all

1 parameter
ParamTypeRequiredDescription
agentIdstringoptionalThe Phantombuster record ID.
GET
phantombuster_get_container
Get a Phantombuster container by ID.

/containers/fetch

1 parameter
ParamTypeRequiredDescription
idstringoptionalThe Phantombuster record ID.