PhantomBuster

53 tools available

PhantomBuster is a cloud-based data extraction and automation platform that enables users to automate actions on the web, such as scraping data, generating leads, and automating social media tasks.

Connect PhantomBuster to Definable to automate repetitive tasks, sync data with the rest of your stack, trigger on real-world events. Personas call PhantomBuster's 53 tools directly from chat or scheduled flows. You can wire it into any persona to read, write, and react when an event fires.

Common workflows with PhantomBuster

01

Trigger on event

  1. Listen for a new event
  2. Parse and validate the payload
  3. Take an action with the linked tool
02

Daily summary

  1. Pull yesterday's activity
  2. Summarise with the model of your choice
  3. Send the digest via email or Slack
03

Cross-tool sync

  1. Read records from one app
  2. Transform with a persona
  3. Write the result back via this integration

PhantomBuster actions 53

Every PhantomBuster action below is a callable tool any Definable persona can invoke.

Abort Agent (v1)

Tool to abort all running instances of an agent using the legacy v1 API. Use when you need to immediately stop an agent's execution. Supports soft abort for graceful shutdown.

Delete Agent

Tool to delete an agent by id. Use when you need to remove a PhantomBuster agent. Ensure the agent is not currently running before deletion.

Delete Lead Objects

Tool to delete one or more lead objects from organization storage. Use when you need to remove lead data. Provide either leadObjectId, or both slug and type parameters.

Delete Many Leads

Tool to delete multiple leads from organization storage. Use when you need to bulk delete leads by their IDs.

Delete List

Tool to delete a storage list by id (Beta). Use when you need to remove a list from organization storage.

Delete Script

Tool to delete a script by id. Use when you need to remove a specific script from PhantomBuster. Optionally specify a branch and environment to delete a specific version.

Get Agent

Tool to get an agent by its ID. Use when you need to retrieve detailed information about a specific Phantombuster agent, including its configuration, schedule, and execution settings.

Get Agent Containers (v1)

Tool to get a list of ended containers for an agent, ordered by date. Use when you need to retrieve the last available output logs from an agent. This is a legacy v1 API endpoint.

Get Agent Output (v1)

Tool to get incremental data from an agent including console output, status, progress and messages. This is a legacy v1 API endpoint designed for easy incremental data retrieval. Use outputPos to track position.

Get All Agents

Tool to fetch all agents associated with the current user or organization. Use after validating your Phantombuster API key to list available agents.

Get Deleted Agents

Tool to get deleted agents for the current user or organization. Use when you need to audit recently removed agents.

Get Branches Diff

Tool to get the length difference between the staging and release branch of all scripts. Use when assessing branch changes before deployment.

Get All Branches

Tool to fetch all branches associated with the current organization. Use when you need to enumerate every branch across your scripts.

Get Containers Fetch All

Tool to get all containers associated with a specified agent. Use when you need to retrieve every container for a given agent, for monitoring or reporting.

Get Leads By List

Tool to fetch leads by their list ID. Use when you need to retrieve leads from a specific list with optional pagination and filtering.

Get IP Location

Tool to retrieve the country of a given or environment IP address. Use when you need to geolocate an IP endpoint. Example: get_location_ip(ip="8.8.8.8")

Export Agent Usage CSV

Tool to export agent usage CSV for current organization. Use when you need a downloadable report of all agents' run statistics in CSV format.

Export Container Usage CSV

Tool to export container usage CSV for current organization. Use when you need a downloadable CSV report of container execution history up to 6 months; URL expires in 30 days.

Get Organization

Tool to fetch current organization details. Use when you need to retrieve the organization associated with the provided API key.

Get Agent Groups

Tool to get agent groups and order for the current organization. Use when you need to review how agents are grouped and ordered.

Get Organization Resources

Tool to get current organization's resources and usage. Use when you need to monitor quotas.

Get Org Running Containers

Tool to get the current organization's running containers. Use after listing agents to identify active containers across the organization.

Get Org Storage Lists Fetch All

Tool to fetch all storage lists for the authenticated organization. Use when you need to enumerate every storage list available (Beta).

Get Script

Tool to fetch a script by its unique ID. Use when you need to retrieve detailed metadata about a specific script, including its branches, visibility, and optionally its source code.

Get Script by Name

Tool to retrieve a script by its name from Phantombuster (Legacy v1 API). Use when you need to fetch script metadata or content by name. Supports both JSON (structured) and raw (plain text) response formats.

Get Script Code

Tool to get the code of a script. Use when you need to retrieve the source code content of a specific script.

Get All Scripts

Tool to fetch all scripts for the current user. Use after authenticating your Phantombuster API key to list scripts without their code bodies.

Get User Information

Tool to get information about your PhantomBuster account and your agents using the legacy v1 API. Use when you need to check account quotas, remaining resources, or list associated agents.

Unschedule All Agent Launches

Tool to unschedule all scheduled launches for agents. Use when you need to disable every automated agent run organization-wide after verifying your API key.

Request AI Completion

Tool to request a text completion from the AI module. Use when you need to generate text based on a prompt.

Create Branch

Tool to create a new branch. Use when you need to isolate updates by creating a separate branch. Use after authenticating with your Phantombuster API key and optionally specifying an organization.

Delete Branch

Tool to delete a branch by id. Use when you need to remove obsolete or incorrect script branches; ensure the branch exists before calling.

Solve hCaptcha

Tool to solve an hCaptcha challenge. Use when you need a valid hCaptcha token for form submissions or automation flows.

Generate Identity Token

Tool to generate an identity token for PhantomBuster. Use when you need to create a new identity token for authentication or session management.

Save Many Leads

Tool to save multiple leads (1-20) to organization storage in a single batch operation (Beta). Use when you need to create or update leads with LinkedIn profile data and optional enrichment fields.

Solve reCAPTCHA

Tool to solve a reCAPTCHA challenge (v2 or v3). Use when you need a valid reCAPTCHA response token for form submissions or automation. Note: API returns 200 status even on errors; check the error field in the response.

Update Script Visibility

Tool to update the visibility of a script. Use when you need to change whether a script is private, public, or open source.

Release Branch

Tool to release a script branch. Use when you need to deploy a branch to production or release changes to specified scripts.

Save Agent

Tool to create a new agent or update an existing one. Use when you need to configure an agent's launch schedule, settings, or behavior. If an agent ID is provided, the existing agent will be updated; otherwise, a new agent is created.

Save Agent Groups

Tool to update agent groups and order for the current user's organization. Use when you need to reorganize agents into groups or change their display order.

Save Company Object

Tool to save one company object to the organization storage. Use when you need to create or update a company object with LinkedIn company data and custom properties.

Save Many Company Objects

Tool to save many company objects to organization storage. Use when you need to bulk insert or update company data with a minimum of 1 and maximum of 20 objects per request.

Save Identity Event

Tool to save an identity event to Phantombuster. Use when you need to record user interactions or activities associated with specific social media profiles.

Save Lead

Tool to save or update a lead in Phantombuster org storage. Use when you need to store LinkedIn profile data or other lead information.

Save Lead Object

Tool to save a lead object to organization storage. Use when you need to store or update lead information with custom properties.

Save Many Lead Objects

Tool to save multiple lead objects to Phantombuster's organization storage. Use when you need to create or update multiple lead objects in a single API call.

Save List

Tool to save (create or update) a list with filter criteria. Use when you need to create a new list or update an existing one by providing a filter configuration. This is a Beta feature.

Save Script

Tool to create a new script or update an existing one. Provide an id to update; otherwise creates new script. Use when you need to save JavaScript automation code to Phantombuster.

Search Company Objects

Tool to search company objects in Phantombuster's organizational storage. Use when you need to find companies by specific criteria or perform a global search.

Search Lead Objects

Tool to search lead objects in Phantombuster org storage. Use when you need to find leads based on search criteria or filter conditions.

Stop Agent

Tool to stop a running agent. Use when you need to halt agent execution, optionally cascading to slave agents or switching to manual launch mode.

Update Script (v1 API)

Tool to update an existing script or create a new one if it does not exist (Legacy v1 API). Use when you need to save script code to Phantombuster. If insertOnly is true, the operation will fail if a script with the same name already exists.

Update Script Access List

Tool to update the access list of a script. Use when you need to add or remove users/orgs from a script's access list in a specific branch.

Frequently asked questions

What can I automate with PhantomBuster on Definable?

Anything PhantomBuster exposes through its API. Common ai web scraping workflows on Definable include automate repetitive tasks, sync data with the rest of your stack, trigger on real-world events. Personas can call any of the 53 PhantomBuster tools directly, then chain the result into another integration without you writing code.

How does PhantomBuster authentication work?

PhantomBuster uses API_KEY on Definable. You connect once from the integrations page, scoped to the permissions you choose, and from then on any persona that has the integration enabled can act on your behalf. Tokens are encrypted at rest and rotated automatically.

Is the PhantomBuster integration included in my Definable plan?

Yes — every Definable plan, including Starter, includes access to all 53 PhantomBuster tools. You only need a separate PhantomBuster subscription if PhantomBuster itself charges per seat or per API call.

Is using PhantomBuster through Definable secure?

Every call from a persona to PhantomBuster is logged with the user, persona, prompt, and response. Tokens never leave Definable's secrets vault, scopes are configurable per persona, and you can revoke access at any time from the integration page.

How do I get started with PhantomBuster on Definable?

Sign up for Definable, open the integrations page, find PhantomBuster, and connect via OAuth or API key. You can immediately attach PhantomBuster to any persona and start running workflows. The free Starter plan includes 5,000 credits/month.

What PhantomBuster actions does Definable expose?

Definable exposes all 53 PhantomBuster actions as callable tools — including `Abort Agent (v1)`, `Delete Agent`, `Delete Lead Objects`, plus 50 more. Each tool gets a typed parameter schema so personas know exactly how to call it.

Ready to automate with PhantomBuster?

Wire it up in minutes. No coding required.

← All integrations