Reference

Request AI Completion

Generate custom text content using AI based on your input prompts, perfect for creating personalized messages, copy, or responses at scale. This helps you automate content creation tasks without writing everything manually.

Get Agent Groups

Retrieves the list of agent groups within your PhantomBuster organization and their ordering, helping you understand how your automation tasks are organized and structured.

Save Agent Groups

Organize and arrange your automation agents into logical groups while controlling their display order in your workspace. Use this when you need to structure your agents for better workflow management and team collaboration.

Get All Agents

Retrieve a complete list of all automation agents available in your PhantomBuster account, allowing you to see what tools and workflows you have set up.

Save Agent

Create a new agent or update an existing one to configure its settings, launch schedule, and behavior for automating repetitive tasks.

Abort Agent (v1)

Stop all running instances of an agent immediately, with the option for a graceful shutdown. This is useful when you need to halt data collection, automation tasks, or processes that are consuming resources or producing unwanted results.

Delete Agent

Remove an agent from your PhantomBuster account to clean up unused automation tools or free up resources. This is useful when you no longer need a specific agent and want to maintain an organized automation workspace.

Get Agent

Retrieve detailed information about a specific PhantomBuster agent, including its configuration, schedule, and execution settings by providing the agent ID.

Get Agent Output (v1)

Retrieves incremental output data from a PhantomBuster agent including console logs, execution status, and progress updates, allowing you to monitor automation runs in real-time.

Get Deleted Agents

Retrieve a list of agents that have been deleted from your account, allowing you to review what automation tasks have been removed and restore them if needed.

Stop Agent

Terminates a running automation agent, allowing you to halt operations immediately when needed and optionally stop dependent agents or switch to manual control.

Unschedule All Agent Launches

Stops all scheduled automated agent runs across your PhantomBuster account in one action. Use this when you need to pause all your automation workflows quickly without managing each one individually.

Create Branch

Creates a new isolated branch in your Phantombuster workspace, allowing you to test changes or manage different versions of your automation without affecting your live workflows.

Delete Branch

Remove an unwanted or obsolete script branch from your PhantomBuster account to keep your automation workflows organized and up-to-date.

Get All Branches

Retrieves a complete list of all branches associated with your organization, allowing you to view and manage your entire branch structure. This is useful when you need visibility into all your automation scripts and their organizational groupings.

Get Branches Diff

Compares the staging and release branches of your scripts to identify what changes are ready to be deployed, helping you understand the scope of updates before going live.

Release Branch

Deploy script changes from a development branch to production, making updates live to your automated workflows.

Solve hCaptcha

Automatically solve hCaptcha challenges to obtain valid tokens for completing automated form submissions and web interactions without manual intervention.

Solve reCAPTCHA

Automatically solves reCAPTCHA challenges (v2 or v3) to obtain valid response tokens for completing form submissions and automated workflows without manual intervention.

Save Company Object

Store and organize company information from LinkedIn and other sources in your centralized database, enabling you to build a searchable repository of prospects and partners.

Save Many Company Objects

Efficiently store or update multiple company records in your organization's database in a single operation, supporting up to 20 companies at once.

Search Company Objects

Find companies in your Phantombuster database by searching for specific criteria, helping you quickly locate and access company information you've previously stored or imported.

Get Agent Containers (v1)

Retrieve a list of completed container executions for a specific agent, ordered by date, to access output logs and execution history from your automation runs.

Get Containers Fetch All

Retrieves all containers associated with a specific agent in your PhantomBuster account, giving you visibility into all active automation tasks and their current status.

Get Org Running Containers

Retrieve a list of all currently active containers running in your organization to monitor which automation tasks are actively processing.

Generate Identity Token

Creates a secure authentication token for PhantomBuster API interactions, enabling your automations to securely access and manage your account resources.

Save Identity Event

Records user interactions and activities linked to social media profiles in Phantombuster, helping you build a complete activity history for contact tracking and follow-up.

Save Lead Object

Store or update lead information in your organization's database with custom properties and fields. This lets you maintain an organized, searchable repository of prospects and contacts for your sales pipeline.

Search Lead Objects

Find and filter leads stored in your Phantombuster organization by applying search criteria, helping you locate specific prospects or segment your lead database for targeted outreach.

Delete Lead Objects

Remove unwanted or duplicate lead records from your organization's database to keep your contact lists clean and accurate. This helps maintain data quality and focus outreach efforts on qualified prospects.

Delete Many Leads

Remove multiple leads from your organization's database at once using their IDs, helping you maintain a clean and current prospect list.

Get Leads By List

Retrieve a batch of leads from a specific list you've created in PhantomBuster, with options to filter and paginate through results. Use this to access lead data organized in your saved lists for outreach, analysis, or integration with other tools.

Save Lead

Store and organize prospect information from LinkedIn profiles or other sources directly into your PhantomBuster database for future reference and outreach.

Save Many Lead Objects

Store or update multiple leads at once in your Phantombuster workspace, making it easy to manage batch lead imports or sync data from other sources.

Save Many Leads

Batch save multiple leads (up to 20) to your organization storage with LinkedIn profile data and enrichment information in one operation. This is useful when you need to quickly import or update lead records from LinkedIn prospecting or other lead generation activities.

Delete List

Remove a stored list from your PhantomBuster organization storage to clean up old data and free up resources. Use this when you no longer need a list you previously created or imported.

Get Org Storage Lists Fetch All

Retrieve a complete list of all storage lists within your organization to see what data collections and datasets you have available. This helps you manage and organize your stored information across PhantomBuster.

Save List

Create or update a list with specific filter criteria to organize and segment your contacts or prospects. This helps you quickly build targeted groups for outreach or analysis.

Get IP Location

Identifies the geographic location (country) of any IP address, helping you understand where your website visitors, customers, or suspicious traffic are coming from. This is useful for targeting, security, and compliance purposes.

Get Organization

Retrieves the current organization details associated with your PhantomBuster account, helping you verify which workspace you're operating in and access your organization's information.

Get Organization Resources

Retrieve your organization's current resource consumption and usage limits to monitor your account's operational capacity. This helps you track quota utilization and plan your automation workload accordingly.

Get All Scripts

Retrieves a complete list of all scripts associated with your Phantombuster account, allowing you to view and manage your automation workflows without needing to download their full code.

Save Script

Create or update JavaScript automation scripts in Phantombuster to automate repetitive web tasks and data collection workflows. This lets you save custom automation code that can run on a schedule or on-demand.

Delete Script

Remove a script from your PhantomBuster account, with the option to delete specific versions or branches. Use this when you no longer need a script or want to clean up outdated automation workflows.

Get Script

Retrieve detailed information about a specific script stored in PhantomBuster, including its configuration, branches, and visibility settings. Use this to access script metadata and understand your automation setup without manually navigating the platform.

Get Script by Name

Retrieve a specific PhantomBuster script by name to access its configuration, metadata, or content for execution or modification. This helps you quickly find and work with automation scripts you've previously created without needing to search through your entire script library.

Get Script Code

Retrieve the complete source code of a specific script stored in your PhantomBuster account. This is useful when you need to review, modify, or understand how an automation script works.

Update Script (v1 API)

Save or modify automation scripts in PhantomBuster to execute repetitive tasks like data scraping, social media posting, or lead generation without manual effort.

Update Script Access List

Manage who can access and use your automation scripts by adding or removing team members and organizations from a script's access list. This ensures the right people have permission to run or modify your automations.

Update Script Visibility

Controls whether a script is private, public, or open source, allowing you to manage access and sharing of your automation workflows.

Export Agent Usage CSV

Download a detailed CSV report of all your agents' performance metrics and run statistics for your organization. This helps you track automation usage, monitor productivity, and analyze agent effectiveness.

Export Container Usage CSV

Download a CSV report of your organization's container execution history and resource usage to analyze automation performance and costs over the past six months.

Get User Information

Retrieve your PhantomBuster account details and view all your configured agents in one place. Use this to monitor your resource usage, check available credits, and manage your automation workflows.