# PhantomBuster 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. - **Category:** ai web scraping - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 53 - **Triggers:** 0 - **Slug:** `PHANTOMBUSTER` - **Version:** 20260429_00 ## Tools ### Abort Agent (v1) **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_DELETE_LEADS_MANY` Tool to delete multiple leads from organization storage. Use when you need to bulk delete leads by their IDs. ### Delete List **Slug:** `PHANTOMBUSTER_DELETE_LIST` Tool to delete a storage list by id (Beta). Use when you need to remove a list from organization storage. ### Delete Script **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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) **Slug:** `PHANTOMBUSTER_GET_AGENT_CONTAINERS` 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) **Slug:** `PHANTOMBUSTER_GET_AGENT_OUTPUT` 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 **Slug:** `PHANTOMBUSTER_GET_AGENTS_FETCH_ALL` 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 **Slug:** `PHANTOMBUSTER_GET_AGENTS_FETCH_DELETED` Tool to get deleted agents for the current user or organization. Use when you need to audit recently removed agents. ### Get Branches Diff **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_GET_BRANCHES_FETCH_ALL` 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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_GET_LOCATION_IP` 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 **Slug:** `PHANTOMBUSTER_GET_ORGS_EXPORT_AGENT_USAGE` 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 **Slug:** `PHANTOMBUSTER_GET_ORGS_EXPORT_CONTAINER_USAGE` 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 **Slug:** `PHANTOMBUSTER_GET_ORGS_FETCH` Tool to fetch current organization details. Use when you need to retrieve the organization associated with the provided API key. ### Get Agent Groups **Slug:** `PHANTOMBUSTER_GET_ORGS_FETCH_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 **Slug:** `PHANTOMBUSTER_GET_ORGS_FETCH_RESOURCES` Tool to get current organization's resources and usage. Use when you need to monitor quotas. ### Get Org Running Containers **Slug:** `PHANTOMBUSTER_GET_ORGS_FETCH_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_GET_SCRIPTS_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 **Slug:** `PHANTOMBUSTER_GET_SCRIPTS_FETCH_ALL` 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 **Slug:** `PHANTOMBUSTER_GET_USER` 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 **Slug:** `PHANTOMBUSTER_POST_AGENTS_UNSCHEDULE_ALL` 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 **Slug:** `PHANTOMBUSTER_POST_AI_COMPLETIONS` Tool to request a text completion from the AI module. Use when you need to generate text based on a prompt. ### Create Branch **Slug:** `PHANTOMBUSTER_POST_BRANCHES_CREATE` 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 **Slug:** `PHANTOMBUSTER_POST_BRANCHES_DELETE` 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 **Slug:** `PHANTOMBUSTER_POST_HCAPTCHA` Tool to solve an hCaptcha challenge. Use when you need a valid hCaptcha token for form submissions or automation flows. ### Generate Identity Token **Slug:** `PHANTOMBUSTER_POST_IDENTITIES_GENERATE_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 **Slug:** `PHANTOMBUSTER_POST_ORG_STORAGE_LEADS_SAVE_MANY` 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 **Slug:** `PHANTOMBUSTER_POST_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 **Slug:** `PHANTOMBUSTER_POST_SCRIPTS_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_SAVE_COMPANY_OBJECTS_MANY` 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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_SAVE_LEADS_OBJECTS_MANY` 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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `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 **Slug:** `PHANTOMBUSTER_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 **Slug:** `PHANTOMBUSTER_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) **Slug:** `PHANTOMBUSTER_UPDATE_SCRIPT` 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 **Slug:** `PHANTOMBUSTER_UPDATE_SCRIPTS_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.