PhantomBuster

MARKETING · MARKETING

Phantoms, their launches, and the leads they collect, on that person’s account.

Connecting PhantomBuster in practice

PhantomBuster’s API queues browser automations rather than answering questions: POST /agents/launch "adds an agent to the launch queue" and the output is collected from the container afterwards, so the work outlives the call that started it. Authentication is the X-Phantombuster-Key-1 header, and the documentation warns against the key query-string alternative "because your key might show up in log files or caches".

Scopes that draw scrutiny

X-Phantombuster-Key-1 One account key with no scopes. It can read scripts and storage, save code and launch agents, so a scraping credential is also a code-deployment credential.
X-Phantombuster-Org Selects the organization context, and some endpoints require it to be omitted, so the same key behaves differently depending on whether the call is org-scoped.

Worth knowing

Concurrency is opt-in per launch: maxInstanceCount means the agent "will only be launched if the number of already running instances is below the specified number", so without it repeated launches stack.
Two API versions are live under https://phantombuster.com/api/<version>/ — v1 and v2 — and v2 is the current one, so copied examples can silently target the older surface.
A launch returns 400 when a parameter is duplicated or the launch argument is too big, so a large bonusArgument fails rather than truncating.
bonusArgument is single-use and merged into the agent’s stored argument, so per-run configuration is a merge rather than a replacement.

Checked against PhantomBuster API guide (2026-09-29), /agents/launch reference (2026-09-29), API reference index (2026-09-29)

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

phantombuster_get_agents_fetchREAD

Gets an agent by id. via GET /agents/fetch

api

phantombuster_get_agents_fetch_allREAD

Gets all agents of the current user's organization. via GET /agents/fetch-all

api

phantombuster_get_agents_fetch_deletedREAD

Gets all deleted agents of the current user's organization. via GET /agents/fetch-deleted

api

phantombuster_get_agents_fetch_outputREAD

Gets the output of the most recent container of an agent. This API endpoint is specifically designed so that it's easy to get incremental data from an agent. via GET /agents/fetch-output

api

phantombuster_get_branches_diffREAD

Gets the length difference between the staging and release branch of all scripts. via GET /branches/diff

api

phantombuster_get_branches_fetch_allREAD

Gets the branches associated with the current organization's id. via GET /branches/fetch-all

api

phantombuster_get_brightdata_serpREAD

Perform a search using brightdata. via GET /brightdata/serp

api

phantombuster_get_buyers_personas_fetch_allREAD

Fetch all buyer personas for an org. via GET /buyers-personas/fetch-all

api

phantombuster_get_containers_fetchREAD

Gets a container by id. via GET /containers/fetch

api

phantombuster_get_containers_fetch_allREAD

Gets all containers associated to a specified agent. via GET /containers/fetch-all

api

phantombuster_get_containers_fetch_outputREAD

Gets the output of a container. via GET /containers/fetch-output

api

phantombuster_get_containers_fetch_result_objectREAD

Gets the result object associated with a container. via GET /containers/fetch-result-object

api

phantombuster_get_icps_fetch_allREAD

Fetch all ICPs for an org. via GET /icps/fetch-all

api

phantombuster_get_location_ipREAD

Retrieves the country of the IP address. via GET /location/ip

api

phantombuster_get_org_storage_lists_fetchREAD

Get one list by ID - Beta. via GET /org-storage/lists/fetch

api

phantombuster_get_org_storage_lists_fetch_allREAD

Get all the lists - Beta. via GET /org-storage/lists/fetch-all

api

phantombuster_get_orgs_export_agent_usageREAD

Gets a csv file containing agent usage info of the current user's organization. via GET /orgs/export-agent-usage

api

phantombuster_get_orgs_export_container_usageREAD

Gets a csv file containing container usage info of the current user's organization. via GET /orgs/export-container-usage

api

phantombuster_get_orgs_fetchREAD

Gets the current organization. via GET /orgs/fetch

api

phantombuster_get_orgs_fetch_agent_groupsREAD

Gets the agent groups and order of the current user's organization. via GET /orgs/fetch-agent-groups

api

phantombuster_get_orgs_fetch_crm_accessREAD

Get the organization's CRM access to be able to fetch CRM resources. via GET /orgs/fetch-crm-access

api

phantombuster_get_orgs_fetch_crm_resourcesREAD

Gets the current organization's CRM requested resources. via GET /orgs/fetch-crm-resources

api

phantombuster_get_orgs_fetch_resourcesREAD

Gets the current organization's resources and usage. via GET /orgs/fetch-resources

api

phantombuster_get_orgs_fetch_running_containersREAD

Gets the current organization's running containers. via GET /orgs/fetch-running-containers

api

phantombuster_get_scoring_fetch_by_idREAD

Fetch a single scoring definition by id. via GET /scoring/fetch/{id}

api

phantombuster_get_scripts_codeREAD

Gets the code of a script. via GET /scripts/code

api

phantombuster_get_scripts_fetchREAD

Gets a script by id. via GET /scripts/fetch

api

phantombuster_get_scripts_fetch_allREAD

Gets all the scripts associated with the current user. via GET /scripts/fetch-all

api

phantombuster_get_users_fetch_meREAD

Gets the current user's info. If a sessionId is not provided the endpoint will create a new session and return the newly created id. via GET /users/fetch-me

api

phantombuster_post_agents_deleteWRITE

Deletes an agent by id. via POST /agents/delete

api

phantombuster_post_agents_launchWRITE

Adds an agent to the launch queue. via POST /agents/launch

api

phantombuster_post_agents_launch_soonWRITE

Schedules an agent to launch before a specific time. via POST /agents/launch-soon

api

phantombuster_post_agents_saveWRITE

Updates or creates a new agent. If an id is provided, the corresponding agent will be updated. Otherwise, a new agent will be created. via POST /agents/save

api

phantombuster_post_agents_stopWRITE

Stops an agent. via POST /agents/stop

api

phantombuster_post_agents_unschedule_allWRITE

Disables the automatic launch for all of the agents from the current organization. via POST /agents/unschedule-all

api

phantombuster_post_ai_adviceWRITE

Get a recommendation from the AI. via POST /ai/advice

api

phantombuster_post_ai_completionsWRITE

Get a completion from the AI. via POST /ai/completions

api

phantombuster_post_branches_createWRITE

Creates a new branch. via POST /branches/create

api

phantombuster_post_branches_deleteWRITE

Deletes a branch by id. via POST /branches/delete

api

phantombuster_post_branches_releaseWRITE

Releases a script branch. via POST /branches/release

api

phantombuster_post_hcaptchaWRITE

Solves an hCaptcha challenge. This endpoint will return a 200 status code even if an error occurs. The error will be set in the response body. via POST /hcaptcha

api

phantombuster_post_identities_events_saveWRITE

Save the identity event. via POST /identities/events/save

api

phantombuster_post_identities_generate_tokenWRITE

Generate identity token. via POST /identities/generate-token

api

phantombuster_post_identities_saveWRITE

Save identity. via POST /identities/save

api

phantombuster_post_identities_save_with_tokenWRITE

Save identity. via POST /identities/save-with-token

api

phantombuster_post_identities_searchWRITE

Search identities. via POST /identities/search

api

phantombuster_post_org_storage_companies_objects_saveWRITE

Save one company object. via POST /org-storage/companies-objects/save

api

phantombuster_post_org_storage_companies_objects_save_manyWRITE

Save many company objects. via POST /org-storage/companies-objects/save-many

api

phantombuster_post_org_storage_companies_objects_searchWRITE

Search companies objects. via POST /org-storage/companies-objects/search

api

phantombuster_post_org_storage_leads_by_list_by_listidWRITE

Fetch leads by their list id. via POST /org-storage/leads/by-list/{listId}

api

phantombuster_post_org_storage_leads_delete_manyWRITE

Delete many leads. via POST /org-storage/leads/delete-many

api

phantombuster_post_org_storage_leads_objects_deleteWRITE

Delete one or more leads objects. via POST /org-storage/leads-objects/delete

api

phantombuster_post_org_storage_leads_objects_saveWRITE

Save one lead object. via POST /org-storage/leads-objects/save

api

phantombuster_post_org_storage_leads_objects_save_manyWRITE

Save many lead objects. via POST /org-storage/leads-objects/save-many

api

phantombuster_post_org_storage_leads_objects_searchWRITE

Search leads objects. via POST /org-storage/leads-objects/search

api

phantombuster_post_org_storage_leads_saveWRITE

Save one lead - Beta. via POST /org-storage/leads/save

api

phantombuster_post_org_storage_leads_save_manyWRITE

Save many leads - Beta. via POST /org-storage/leads/save-many

api

phantombuster_post_org_storage_lists_deleteWRITE

Delete a list - Beta. via POST /org-storage/lists/delete

api

phantombuster_post_org_storage_lists_saveWRITE

Save a list - Beta. For more information, see the [Creating and updating leads lists using filters](https://hub.phantombuster.com/docs/creating-and-updating-leads-lists-using-filters) page in the Developer Guides. via POST /org-storage/lists/save

api

phantombuster_post_orgs_saveWRITE

Updates the current organization's info. Only web or MCP sessions are allowed to call this endpoint. Omit the `X-Phantombuster-Org` header to call this endpoint. via POST /orgs/save

api

phantombuster_post_orgs_save_agent_groupsWRITE

Updates the agent groups and order of the current user's organization. via POST /orgs/save-agent-groups

api

phantombuster_post_orgs_save_crm_contactWRITE

Save new contacts to CRM. via POST /orgs/save-crm-contact

api

phantombuster_post_recaptchaWRITE

Solves a reCAPTCHA challenge. Supports reCAPTCHA v3 and v2. This endpoint will return a 200 status code even if an error occurs. The error will be set in the response body. via POST /recaptcha

api

phantombuster_post_scripts_access_listWRITE

Updates the access list of a script. via POST /scripts/access-list

api

phantombuster_post_scripts_deleteWRITE

Deletes a script by id. via POST /scripts/delete

api

phantombuster_post_scripts_saveWRITE

Updates or creates a new script. If an id is provided, the corresponding script will be updated. Otherwise, a new script will be created. via POST /scripts/save

api

phantombuster_post_scripts_visibilityWRITE

Updates the visibility of a script. via POST /scripts/visibility

api

phantombuster_post_users_update_meWRITE

Updates the current user's info. via POST /users/update-me

api