Skip to main content
PhantomBuster logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 53
  • Triggers: 0
  • Slug: PHANTOMBUSTER
  • Version: 20261101_00

Tools

Slug: PHANTOMBUSTER_ABORT_AGENT_V1Tool 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.

Input Parameters

integer
required
ID of the agent to abort. All running instances of this agent will be stopped.
boolean
If true, attempts a soft abort of the agent. Soft abort allows the agent to gracefully finish its current operation before stopping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_DELETE_AGENTTool to delete an agent by id. Use when you need to remove a PhantomBuster agent. Ensure the agent is not currently running before deletion.

Input Parameters

string
required
Id of the agent to delete.
string
ID of the org that is performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_DELETE_LEAD_OBJECTSTool 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.

Input Parameters

string
Slug of the object to delete. Must be used together with type parameter.
string
Type of object to delete. Must be used together with slug parameter.
string
ID of a lead object to delete. Provide either leadObjectId, or both slug and type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_DELETE_LEADS_MANYTool to delete multiple leads from organization storage. Use when you need to bulk delete leads by their IDs.

Input Parameters

array
required
List of lead IDs to delete. Each ID must be a valid lead identifier string.
string
ID of the org that is performing the operation (not necessary when using a third party key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_DELETE_LISTTool to delete a storage list by id (Beta). Use when you need to remove a list from organization storage.

Input Parameters

string
required
Id of the list to delete.
string
ID of the org that is perfoming the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_DELETE_SCRIPTTool 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.

Input Parameters

string
required
Id of the script to delete.
string
Branch of the script to delete. Must be 1-50 characters, alphanumeric, underscores, or hyphens.
string ("staging" | "release")
Enum for script branch environment.
string
ID of the org that is performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_AGENTTool 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.

Input Parameters

string
required
Id of the agent to fetch.
string
Set to “true” if you want to include the agent’s script code in the response
string
Set to “true” if you want to include the agent’s slave agents in the response
string
Set to “true” if you want to return the agent’s manifest in the response
string
Set to “true” if you want to include the agent’s sub-slave agents in the response (requires withSlaves=true)
string
Set to “true” if you want to include the agent_object in the response
string
ID of the org that is perfoming the operation (not necessary when using a third party key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_AGENT_CONTAINERSGet a list of ended containers for an agent, ordered by date, using the legacy v1 API. The returned container records include launch and end details.

Input Parameters

string
required
ID of the agent from which to retrieve the containers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_AGENT_OUTPUTTool 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.

Input Parameters

string
required
ID of the agent from which to retrieve the output, status and messages.
string ("track" | "most-recent")
Mode for selecting which agent instance to track.
integer
ID of the specific instance from which to get console output. Required when mode is ‘track’.
integer
Return the agent’s console output starting from this position. Use for incremental retrieval.
boolean
If true, omit the agent’s result object from the response to reduce payload size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_AGENTS_FETCH_ALLFetch all agents associated with the current user or organization to list the available agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_AGENTS_FETCH_DELETEDTool to get deleted agents for the current user or organization. Use when you need to audit recently removed agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_BRANCHES_DIFFTool to get the length difference between the staging and release branch of all scripts. Use when assessing branch changes before deployment.

Input Parameters

string
required
Name of the script branch to fetch the diff from.
string
ID of the org performing the operation. Not required when using a personal API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_BRANCHES_FETCH_ALLTool to fetch all branches associated with the current organization. Use when you need to enumerate every branch across your scripts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_CONTAINERS_FETCH_ALLFetch containers associated with a specified agent for monitoring or reporting. The response indicates whether the maximum fetch limit was reached.

Input Parameters

string
required
ID of the agent whose containers will be fetched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_LEADS_BY_LISTFetch leads from a specific list by its ID, with optional pagination and associated company or lead-object data.

Input Parameters

string
required
Id of the lead list to fetch leads from.
boolean
Option for retrieving the company associated to the lead.
object
Options for paginating through leads.
string
ID of the org that is performing the operation (not necessary when using a third party key).
array
Array of lead object types (max 3 items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_LOCATION_IPTool 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”)

Input Parameters

string
IPv4 or IPv6 address to retrieve the country of. Omit to use the current environment’s public IP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_EXPORT_AGENT_USAGETool to export agent usage CSV for current organization. Use when you need a downloadable report of all agents’ run statistics in CSV format.

Input Parameters

integer
required
Number of days of data to export (1 to 180).
string
If set, export data only for this agent ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_EXPORT_CONTAINER_USAGETool 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.

Input Parameters

integer
required
Number of days of data to export (1 to 180).
string
If set, export data only for this agent ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_FETCHTool to fetch current organization details. Use when you need to retrieve the organization associated with the provided API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_FETCH_AGENT_GROUPSTool to get agent groups and order for the current organization. Use when you need to review how agents are grouped and ordered.

Input Parameters

string
ID of the org performing the operation (omit if using your own API key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_FETCH_RESOURCESTool to get current organization’s resources and usage. Use when you need to monitor quotas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORGS_FETCH_RUNNING_CONTAINERSTool to get the current organization’s running containers. Use after listing agents to identify active containers across the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_ORG_STORAGE_LISTS_FETCH_ALLTool to fetch all storage lists for the authenticated organization. Use when you need to enumerate every storage list available (Beta).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_SCRIPTTool 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.

Input Parameters

string
required
Id of the script to fetch.
string
If set, the specified branch will be used to retrieve the script.
string ("staging" | "release")
Environment enumeration for withCode parameter.
string ("staging" | "release")
Environment enumeration for script branches.
string
ID of the org that is performing the operation. Not necessary when using a third party key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_SCRIPT_BY_NAMERetrieve a script by name using PhantomBuster’s legacy v1 API, returning structured JSON metadata and content when available.

Input Parameters

string ("json")
Response format: ‘json’ returns structured metadata.
string
required
Name of the script to retrieve, with its extension (.js or .coffee).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_SCRIPTS_CODETool to get the code of a script. Use when you need to retrieve the source code content of a specific script.

Input Parameters

string
If set, the specified org will be used to fetch the code.
string
If set, the specified branch will be used to fetch the code.
string
required
Name of the script to fetch the code from.
string ("staging" | "release")
Environment enum for script code fetching.
string
ID of the org that is performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_SCRIPTS_FETCH_ALLTool to fetch all scripts for the current user. Use after authenticating your Phantombuster API key to list scripts without their code bodies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_GET_USERTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_AGENTS_UNSCHEDULE_ALLTool to unschedule all scheduled launches for agents. Use when you need to disable every automated agent run organization-wide after verifying your API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_AI_COMPLETIONSTool to request a text completion from the AI module. Use when you need to generate text based on a prompt.

Input Parameters

integer
Number of completion choices to generate.
array
Sequences where the API will stop generating further tokens.
number
Nucleus sampling probability between 0 and 1.
string
Identifier of the AI model to use for the completion.
string
required
Input text prompt to generate a completion for.
integer
Maximum number of tokens to generate in the completion.
number
Sampling temperature between 0 and 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_BRANCHES_CREATETool 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.

Input Parameters

string
required
Name of the branch to create.
string
ID of the organization performing the operation (not needed when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_BRANCHES_DELETETool to delete a branch by id. Use when you need to remove obsolete or incorrect script branches; ensure the branch exists before calling.

Input Parameters

string
required
The unique identifier of the branch to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_HCAPTCHATool to solve an hCaptcha challenge. Use when you need a valid hCaptcha token for form submissions or automation flows.

Input Parameters

string
Proxy URL (e.g., http://user:pass@host:port) to route requests through.
string
required
Full URL of the page where the hCaptcha appears.
string
required
The public site key of the hCaptcha widget.
string
Custom User-Agent to simulate in the solving request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_IDENTITIES_GENERATE_TOKENTool to generate an identity token for PhantomBuster. Use when you need to create a new identity token for authentication or session management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_ORG_STORAGE_LEADS_SAVE_MANYTool 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.

Input Parameters

array
required
Array of leads to save. Must contain between 1 and 20 leads. Each lead requires a linkedinProfileUrl.
string
ID of the organization performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_RECAPTCHARequest a reCAPTCHA v2 or v3 response token for form submissions or automation. For v3 challenges, a minimum score and page action can also be specified.

Input Parameters

string
required
The site key of the reCAPTCHA widget (found in the page HTML or network requests).
string
required
Full URL of the page where the reCAPTCHA widget appears.
string ("v2" | "v3")
required
Version of reCAPTCHA to solve: ‘v2’ for checkbox or invisible reCAPTCHA, ‘v3’ for score-based reCAPTCHA.
number
Minimum score required for reCAPTCHA v3 (between 0 and 1). Only applicable for type=‘v3’.
string
Action name for reCAPTCHA v3 (matches the action parameter in grecaptcha.execute). Only applicable for type=‘v3’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_POST_SCRIPTS_VISIBILITYUpdate the visibility of a specified script branch, including private, public, and open-source visibility levels.

Input Parameters

string
required
Name of the script to change visibility for.
string
required
Name of the branch to change visibility for.
string ("private" | "semi public" | "public" | "semi open source" | "open source")
required
New branch visibility.
string
ID of the organization performing the operation (not needed when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_RELEASE_BRANCHTool to release a script branch. Use when you need to deploy a branch to production or release changes to specified scripts.

Input Parameters

string
required
Name of the branch to release.
array
required
List of script IDs to release.
string
ID of the organization performing the operation (not needed when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_AGENTTool 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.

Input Parameters

string
If provided, updates the existing agent with this ID. If omitted, creates a new agent.
string
Organization to link the agent to (pattern: ^(deleted_\d{1,16}-)?[a-z][a-z0-9-]{1,48}[a-z0-9]$).
string
Name of the agent (max 100 characters)
string
Branch to assign the agent to (alphanumeric, dash, max 50)
string
Script filename to assign to the agent (e.g., ‘myscript.js’)
string
Default argument used to launch the agent (string or object)
integer
Unix timestamp (epoch ms) when the agent will be deleted.
string ("folders" | "mix" | "delete")
Agent file management type.
string ("none" | "http" | "pool" | "squid lease")
Proxy type configuration.
string ("manually" | "repeatedly" | "once" | "after agent")
Launch type for the agent.
string
Sets the agent’s object as a JSON string.
string ("staging" | "release")
Script branch environment.
integer
Must be set when launchType is ‘once’. Unix timestamp (epoch ms) for single launch.
string
HTTP proxy address (for proxyType=‘http’) or proxy pool name (for proxyType=‘pool’).
object
Notification settings for the agent.
string
Password for proxy authentication (used with proxyType=‘http’).
string
Username for proxy authentication (used with proxyType=‘http’).
string
Optional key for idempotent operations - only for creating an agent.
integer
Maximum number of concurrent executions of the agent.
integer
Maximum number of retries the agent will attempt before aborting.
number
Execution time limit in seconds. Agent will be stopped if this limit is exceeded.
integer
Maximum number of folders for file management.
string
Must be set when launchType is ‘after agent’. ID of the agent that triggers this agent.
object
Schedule configuration for repeated launches.
string ("Once every other day" | "Once per day" | "Once per day, at the start of the day" | "Twice per day" | "Thrice per day" | "4 times per day" | "6 times per day" | "8 times per day" | "Once every other hour" | "Once per hour" | "Twice per hour" | "Thrice per hour" | "4 times per hour" | "Once every other working hour" | "Once per working hour" | "Twice per working hour" | "Thrice per working hour" | "4 times per working hour" | "Once every other working hour, excluding weekends" | "Once per working hour, excluding weekends" | "Twice per working hour, excluding weekends" | "Thrice per working hour, excluding weekends" | "4 times per working hour, excluding weekends")
Preset launch schedules.
object
Squid lease configuration.
number
Delay in seconds before launching after a slave agent finishes. Platform defaults to 10-15 minutes if not set.
string
Launch if slave agent’s exit code matches array values, or set to ‘all’ to launch on any exit code.
boolean
If true, applies the manifest’s default settings to the agent.
boolean
If true, the agent’s setup is considered complete.
boolean
If true, propagates updated settings to workers regardless of session type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_AGENT_GROUPSTool 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.

Input Parameters

array
required
New agent groups. Can be a list of agent IDs (strings) or AgentGroup objects with id, name, and agents. Order of the groups and agents will be preserved.
string
ID of the org performing the operation (not necessary when using a third party key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_COMPANY_OBJECTTool 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.

Input Parameters

string
The internal id of the company object. If provided, updates the existing object.
string
required
The slug of the company object.
string
required
The type of company object.
string
The org id associated with the company object.
object
required
The properties of the object. Can contain any additional company data.
string
required
The external id of the company scraped from LinkedIn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_COMPANY_OBJECTS_MANYTool 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.

Input Parameters

array
required
List of company objects to save. Minimum 1, maximum 20 objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_IDENTITY_EVENTTool to save an identity event to Phantombuster. Use when you need to record user interactions or activities associated with specific social media profiles.

Input Parameters

integer
Optional timestamp of the identity event in milliseconds since epoch. Must be between 1000000000000 and 9999999999999.
object
required
Event data of the identity event containing additional information about the event.
string
required
Type of the identity event (e.g., profile_view, connection_request).
string
required
Profile ID of the identity event.
string
required
Identity type of the identity event (e.g., linkedin, twitter, facebook).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_LEADTool to save or update a lead in Phantombuster org storage. Use when you need to store LinkedIn profile data or other lead information.

Input Parameters

string
Error message if there was an issue processing the lead.
string
Civility or title of the lead (e.g., Mr., Ms., Dr.).
string
Last name of the lead.
string
Geographic location of the lead.
object
Additional metadata for the lead.
array
List of websites associated with the lead.
string
First name of the lead.
string
Current company name of the lead.
array
List of phone numbers of the lead.
string
Website of the lead’s current company.
array
List of personal email addresses of the lead.
array
Audience segments this lead belongs to.
string
Industry of the lead’s current company.
string
LinkedIn headline of the lead.
string
Current job title of the lead on LinkedIn.
string
LinkedIn company ID of the lead’s current company.
string
LinkedIn profile ID of the lead.
string
Twitter profile URL of the lead.
string
LinkedIn company URL.
string
required
LinkedIn profile URL of the lead (required). This is the unique identifier for the lead.
string
URN of the lead’s LinkedIn profile.
string
Name of the lead’s school on LinkedIn.
array
List of professional email addresses of the lead.
string
ID of the org that is performing the operation (not necessary when using a third party key).
string
LinkedIn company slug.
string
LinkedIn description or summary of the lead.
string
Location of the lead’s current job on LinkedIn.
boolean
Whether the lead has an open LinkedIn profile.
string
Skills label from the lead’s LinkedIn profile.
string
Name of the lead’s previous company.
string
Date range of the lead’s current job on LinkedIn.
string
Degree obtained at the lead’s school on LinkedIn.
object
AI-generated properties for the lead.
string
Custom results file name for the lead.
boolean
Whether the lead has a hiring badge on LinkedIn.
number
Number of LinkedIn followers the lead has.
string
Description of the lead’s current job on LinkedIn.
string
URL of the lead’s LinkedIn profile image.
string
URN of the lead’s LinkedIn profile image.
string
Date range of the lead’s school attendance on LinkedIn.
string
Previous job title of the lead on LinkedIn.
string
LinkedIn URL of the lead’s school.
string
Sales Navigator profile URL of the lead.
boolean
Whether the lead has an open to work badge on LinkedIn.
string
Description of the lead’s school on LinkedIn.
string
LinkedIn URL of the lead’s previous company.
string
Name of the lead’s previous school on LinkedIn.
string
Location of the lead’s previous job on LinkedIn.
array
CRM account relative properties for the lead.
string
Date range of the lead’s previous job on LinkedIn.
string
Degree obtained at the lead’s previous school on LinkedIn.
string
Description of the lead’s previous job on LinkedIn.
string
Date range of the lead’s previous school attendance on LinkedIn.
string
LinkedIn URL of the lead’s previous school.
array
LinkedIn account relative properties for the lead.
string
Description of the lead’s previous school on LinkedIn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_LEAD_OBJECTTool to save a lead object to organization storage. Use when you need to store or update lead information with custom properties.

Input Parameters

string
required
Slug of the object to save. Must be 470 characters or less.
string
required
Type of object to save.
string
ID of a lead to associate with this object.
string
required
ID of the agent associated with this lead object.
string
URN of a lead to associate with this object.
string
Slug of a lead to associate with this object.
object
required
Properties of the object. Can contain any key-value pairs.
string
ID of a lead object to update. If provided, updates existing object instead of creating new one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_LEADS_OBJECTS_MANYTool 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.

Input Parameters

array
required
Array of lead objects to save. Each object must include type, slug, properties, and agentId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_LISTTool 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.

Input Parameters

string
A string for updating existing lists (omit when creating new ones).
string
required
A string specifying the list’s title.
array
An array of strings for organizational categorization. Allowed values: ‘hidden’, ‘workflow’, ‘pbai’, ‘opinion-leaders’
object
required
An object that configures which leads are included in the list. Supports global search using ‘global_search’ key, simple field filters, logical AND/OR operators, and complex nested filters. Example: {‘global_search’: ‘test’} or {‘email’: ‘user@example.com’}
string
A string describing the list’s purpose.
string
ID of the org that is performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SAVE_SCRIPTTool 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.

Input Parameters

string
If provided, the script with this ID will be updated. Otherwise, a new script is created.
string
JavaScript source code of the script (max 600,000 chars).
string
required
Name of the script file. Must end with .js or .coffee. Prepend with ‘lib-’ to define as a module.
string
Name of the branch to associate with the script (alphanumeric, hyphens, 1-50 chars).
object
JSON script manifest required to create/update a script.
string
Markdown description of the script (max 200,000 chars).
string
ID of the organization performing the operation (not needed when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SEARCH_COMPANY_OBJECTSTool to search company objects in Phantombuster’s organizational storage. Use when you need to find companies by specific criteria or perform a global search.

Input Parameters

array
Array of filter conditions joined by OR logic. Each condition is an object with field names as keys and string values.
array
Array of filter conditions joined by AND logic. Each condition is an object with field names as keys and string values.
object
Nested filter object for more complex filtering logic with field names as keys and string values.
Global search string to search across all fields of company objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_SEARCH_LEAD_OBJECTSTool to search lead objects in Phantombuster org storage. Use when you need to find leads based on search criteria or filter conditions.

Input Parameters

object
required
Filter criteria for searching leads. Use ‘global_search’ for simple text searches across all fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_STOP_AGENTTool to stop a running agent. Use when you need to halt agent execution, optionally cascading to slave agents or switching to manual launch mode.

Input Parameters

string
required
Id of the agent to stop.
boolean
If true, tries to softly abort the agent.
boolean
If true, disables the next scheduled ‘launch soon’ of the agent.
boolean
If true, slave agents will recursively be stopped (even nested slaves).
boolean
If true, the agent will switch to manual launch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_UPDATE_SCRIPTTool 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.

Input Parameters

string
required
Name of the script to update or create, with its extension (.js or .coffee).
string
required
Full text contents of the script.
boolean
If true, make sure that we don’t update an existing script. An error will be returned if a script with the same name already exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHANTOMBUSTER_UPDATE_SCRIPTS_ACCESS_LISTTool 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.

Input Parameters

string
Org or user to add in the access list.
string
required
Name of the script to update the access list of.
string
required
Name of the branch to update the access list of.
string
Org or user to remove from the access list.
string
ID of the org that is performing the operation (not necessary when using a third party key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not