PhantomBuster MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'phantombustermcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize PhantomBuster MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'phantombustermcp_identities_search',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "phantombustermcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize PhantomBuster MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="phantombustermcp_identities_search",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Update users — Updates the current authenticated user’s profile information
• Fetch users, scripts — Retrieves the current authenticated user’s profile information including account details and session data
• Visibility scripts — Updates the visibility of a script branch on PhantomBuster
• Save scripts, orgs, org storage lists — Creates a new script or updates an existing one on PhantomBuster
• Delete scripts, org storage lists, org storage leads objects — Deletes a PhantomBuster script by its ID
• Code scripts — Gets the source code of a PhantomBuster script by name

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

phantombustermcp_agents_delete#Permanently deletes a PhantomBuster agent by its unique ID. This action is irreversible and will remove the agent and all associated data.1 param▾

Permanently deletes a PhantomBuster agent by its unique ID. This action is irreversible and will remove the agent and all associated data.

NameTypeRequiredDescription

idstringrequiredUnique ID of the agent to delete.

phantombustermcp_agents_fetch#Retrieve a PhantomBuster agent by its unique ID. Returns agent metadata and optionally includes the agent's manifest, object definition, script code, slave agents, and sub-slave agents depending on the query flags provided.6 params▾

Retrieve a PhantomBuster agent by its unique ID. Returns agent metadata and optionally includes the agent's manifest, object definition, script code, slave agents, and sub-slave agents depending on the query flags provided.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the PhantomBuster agent to fetch. Required. Example: '1234567890'.

withAgentObjectstringoptionalSet to "true" to include the full agent_object definition in the response. Useful when you need the agent's configuration object. Example: "true".

withCodestringoptionalSet to "true" to include the agent's script source code in the response. Example: "true".

withManifeststringoptionalSet to "true" to include the agent's manifest (capabilities and configuration schema) in the response. Example: "true".

withSlavesstringoptionalSet to "true" to include the agent's slave agents (sub-automation agents linked to this agent) in the response. Example: "true".

withSubSlavesstringoptionalSet to "true" to include the agent's sub-slave agents in the response. Requires withSlaves to also be set to "true". Example: "true".

phantombustermcp_agents_fetch_all#Retrieves all agents belonging to the current user's organization on PhantomBuster. Supports filtering by input types, output types, and specific agent IDs.5 params▾

Retrieves all agents belonging to the current user's organization on PhantomBuster. Supports filtering by input types, output types, and specific agent IDs.

NameTypeRequiredDescription

agentIdsstringoptionalIf set, only the agents with the provided IDs will be returned. Can be a single ID or an array of IDs (max 100).

inputTypesstringoptionalFilter agents by input types they consume (e.g. 'profileUrl', 'companyUrl'). Can be a single string or an array of strings.

outputTypesstringoptionalFilter agents by output types they produce (e.g. 'fullName', 'job', 'company'). Can be a single string or an array of strings.

withAgentSlotsFactorstringoptionalSet to 'true' to include the agent's reservedAgentSlotsFactor from the script branch configuration in the response.

withArgumentstringoptionalSet to 'true' to include each agent's default argument in the response.

phantombustermcp_agents_fetch_deleted#Retrieves all deleted agents belonging to the current user's organization on PhantomBuster. Useful for auditing or recovering information about previously deleted automations.0 params▾

Retrieves all deleted agents belonging to the current user's organization on PhantomBuster. Useful for auditing or recovering information about previously deleted automations.

phantombustermcp_agents_fetch_output#Gets the output of the most recent container of an agent. Designed for incremental data retrieval — use fromOutputPos and prevContainerId to fetch only new output since your last call.5 params▾

Gets the output of the most recent container of an agent. Designed for incremental data retrieval — use fromOutputPos and prevContainerId to fetch only new output since your last call.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the agent to fetch output from.

fromOutputPosnumberoptionalIf set, the returned output will start from the specified position, enabling incremental output fetching.

prevContainerIdstringoptionalIf set, the output will be retrieved from the container that ran after the specified previous container ID.

prevRuntimeEventIndexnumberoptionalIf set, the container's runtime events will be returned starting from the specified index, enabling incremental event fetching.

prevStatusstringoptionalIf set, defines the container status that was previously observed on the client side. Accepted values: 'starting', 'running', 'finished', 'unknown', 'launch error', 'never launched'.

phantombustermcp_agents_launch#Add a PhantomBuster agent to the launch queue to trigger a new execution. Supports passing arguments, bonus arguments (single-use overrides), controlling instance limits, and tagging the resulting container with metadata.10 params▾

Add a PhantomBuster agent to the launch queue to trigger a new execution. Supports passing arguments, bonus arguments (single-use overrides), controlling instance limits, and tagging the resulting container with metadata.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the agent to launch. Required.

argumentstringoptionalAgent argument passed to the execution. Can be a JSON string or a plain object. Accessible in the agent's script via buster.argument.

argumentsstringoptionalAgent argument (alias for 'argument'). Can be a JSON string or a plain object. Accessible in the agent's script via buster.argument.

bonusArgumentstringoptionalSingle-use bonus argument for this launch only. Can be a JSON string or a plain object. Merged with the main argument to form the effective argument available via buster.argument in the agent's script.

internalMetadatastringoptionalPhantomBuster-managed key-value pairs used for internal container tagging. Can be null.

manualLaunchbooleanoptionalIf true, the agent will be marked as 'launched manually' rather than via automation.

maxInstanceCountnumberoptionalIf set, the agent will only be launched if the current number of running instances is below this threshold. Minimum value: 1.

saveArgumentbooleanoptionalIf true, the provided argument will be saved as the default launch options for this agent.

saveArgumentsbooleanoptionalAlias for 'saveArgument'. If true, the provided argument will be saved as the default launch options for this agent.

userCustomMetadatastringoptionalUser-defined key-value pairs for tagging the resulting container. Can be null.

phantombustermcp_agents_launch_soon#Schedules an agent to launch before a specific time. The agent will automatically start within the specified number of minutes unless it is launched manually before then.6 params▾

Schedules an agent to launch before a specific time. The agent will automatically start within the specified number of minutes unless it is launched manually before then.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the agent to schedule for launch.

minutesintegerrequiredNumber of minutes from now before the agent will automatically launch. If the agent is launched manually before this time, the automatic launch will not occur.

argumentstringoptionalAgent argument to pass at launch. Can be a JSON string or a plain object. Accessible in the agent's script via buster.argument.

argumentsstringoptionalAgent argument (plural form). Can be a JSON string or a plain object. Accessible in the agent's script via buster.argument.

saveArgumentbooleanoptionalIf true, the provided argument will be saved as the default launch options for the agent.

saveArgumentsbooleanoptionalIf true, the provided argument will be saved as the default launch options for the agent (plural form).

phantombustermcp_agents_save#Creates a new PhantomBuster agent or updates an existing one. If an id is provided the corresponding agent will be updated. Otherwise a new agent will be created. Supports configuring script assignment, scheduling, notifications, proxy settings, and more.19 params▾

Creates a new PhantomBuster agent or updates an existing one. If an id is provided the corresponding agent will be updated. Otherwise a new agent will be created. Supports configuring script assignment, scheduling, notifications, proxy settings, and more.

NameTypeRequiredDescription

agentObjectstringoptionalJSON string representing the agent's object configuration.

branchstringoptionalIf set, the upserted agent will be assigned to the specified branch.

environmentstringoptionalIf set, the upserted agent will be assigned to the specified environment: 'staging' or 'release'.

executionTimeLimitnumberoptionalMaximum execution time in seconds. If exceeded, the agent will be stopped.

fileMgmtstringoptionalFile management type: 'folders' creates new files, 'mix' combines new and previous, 'delete' removes previous files.

idstringoptionalIf set, the agent with the corresponding id will be updated. Omit to create a new agent.

idempotencyKeystringoptionalOptional key to ensure idempotent agent creation. Only applies when creating a new agent.

launchAfterAgentIdstringoptionalID of the agent whose completion triggers this agent's launch. Required when launchType is 'after agent'.

launchOnceAtnumberoptionalUnix timestamp for when to launch the agent once. Required when launchType is 'once'.

launchTypestringoptionalSets how the agent will be launched: 'manually', 'repeatedly', 'once', or 'after agent'.

maxParallelismnumberoptionalMaximum number of concurrent executions for this agent.

maxRetryNumbernumberoptionalMaximum number of retry attempts before the agent aborts.

namestringoptionalDisplay name for the agent. Maximum 100 characters.

orgstringoptionalIf set, the upserted agent will be linked to the specified organization slug.

proxyAddressstringoptionalHTTP proxy address when proxyType is 'http', or proxy pool name when proxyType is 'pool'.

proxyPasswordstringoptionalPassword for proxy authentication. Used when proxyType is 'http'.

proxyTypestringoptionalProxy type to use: 'none', 'http', 'pool', or 'squid lease'.

proxyUsernamestringoptionalUsername for proxy authentication. Used when proxyType is 'http'.

scriptstringoptionalIf set, the upserted agent will be assigned to the specified script filename.

phantombustermcp_agents_stop#Stops a running PhantomBuster agent. Supports soft abort, cascading stop to slave agents, disabling next scheduled launch, and switching to manual launch mode.5 params▾

Stops a running PhantomBuster agent. Supports soft abort, cascading stop to slave agents, disabling next scheduled launch, and switching to manual launch mode.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the agent to stop.

cascadeToAllSlavesbooleanoptionalIf true, all slave agents linked to this agent will also be recursively stopped, including nested slaves.

dontLaunchSoonbooleanoptionalIf true, disables the next scheduled 'launch soon' for this agent after stopping.

softAbortbooleanoptionalIf true, attempts to softly abort the agent rather than forcefully stopping it.

switchToManualLaunchbooleanoptionalIf true, switches the agent to manual launch mode after stopping.

phantombustermcp_agents_unschedule_all#Disables the automatic launch schedule for all agents in the current organization. After calling this, no agents will launch automatically until re-scheduled.0 params▾

Disables the automatic launch schedule for all agents in the current organization. After calling this, no agents will launch automatically until re-scheduled.

phantombustermcp_branches_create#Creates a new script branch in PhantomBuster. Branches allow you to develop and test script changes in isolation before releasing them to production.1 param▾

Creates a new script branch in PhantomBuster. Branches allow you to develop and test script changes in isolation before releasing them to production.

NameTypeRequiredDescription

namestringrequiredName of the branch to create. Must be 1-50 characters and contain only word characters and hyphens (matching pattern ^[\w-]{1,50}$).

phantombustermcp_branches_delete#Permanently deletes a script branch by its ID. This action cannot be undone — all scripts associated with the branch will be removed from that branch.1 param▾

Permanently deletes a script branch by its ID. This action cannot be undone — all scripts associated with the branch will be removed from that branch.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the branch to delete.

phantombustermcp_branches_diff#Retrieve the length difference between the staging and release branches for all scripts in the organization, optionally filtered by a specific script branch name. Use this to understand what changes are pending deployment.1 param▾

Retrieve the length difference between the staging and release branches for all scripts in the organization, optionally filtered by a specific script branch name. Use this to understand what changes are pending deployment.

NameTypeRequiredDescription

namestringoptionalThe name of the script branch to fetch the diff for. Must be 1-50 characters, containing only word characters and hyphens.

phantombustermcp_branches_fetch_all#Retrieve all script branches associated with the authenticated organization. Branches represent different versions (staging vs. release) of PhantomBuster agent scripts and are used for managing deployments.0 params▾

Retrieve all script branches associated with the authenticated organization. Branches represent different versions (staging vs. release) of PhantomBuster agent scripts and are used for managing deployments.

phantombustermcp_branches_release#Releases one or more scripts from a named branch to production. Scripts listed in scriptIds will be promoted from the specified branch into the release environment.2 params▾

Releases one or more scripts from a named branch to production. Scripts listed in scriptIds will be promoted from the specified branch into the release environment.

NameTypeRequiredDescription

namestringrequiredName of the branch to release. Must be 1-50 characters and contain only word characters and hyphens.

scriptIdsarrayrequiredArray of script IDs to release from the specified branch.

phantombustermcp_buyers_personas_fetch_all#Fetch all buyer personas defined for the organization. Returns the full list of buyer persona records without requiring any input parameters.0 params▾

Fetch all buyer personas defined for the organization. Returns the full list of buyer persona records without requiring any input parameters.

phantombustermcp_containers_fetch#Retrieve a PhantomBuster container by its unique ID. Optionally include the result object, output data, runtime events, and navigation links to adjacent containers in the response.5 params▾

Retrieve a PhantomBuster container by its unique ID. Optionally include the result object, output data, runtime events, and navigation links to adjacent containers in the response.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the container to retrieve. Required.

withNewerAndOlderContainerIdstringoptionalIf set, the response will include the IDs of the next newer and next older containers relative to this one.

withOutputstringoptionalIf set, the output produced by the container will be included in the response.

withResultObjectstringoptionalIf set, the container's result object will be included in the response.

withRuntimeEventsstringoptionalIf set, the runtime events associated with the container will be included in the response.

phantombustermcp_containers_fetch_all#Retrieve all containers associated with a specified PhantomBuster agent. Supports filtering by completion date, limiting result count, and optionally including runtime events. Containers represent individual executions of an agent.5 params▾

Retrieve all containers associated with a specified PhantomBuster agent. Supports filtering by completion date, limiting result count, and optionally including runtime events. Containers represent individual executions of an agent.

NameTypeRequiredDescription

agentIdstringrequiredThe unique identifier of the agent whose containers to retrieve. Required.

beforeEndedAtstringoptionalIf set, only containers that ended before this date will be returned. Use ISO 8601 date format.

limitstringoptionalIf set, limits the number of containers returned to this value.

modestringoptionalFilter containers by status. 'all' returns all containers; 'finalized' returns only completed containers.

withRuntimeEventsstringoptionalIf set, the response will include runtime events for each container.

phantombustermcp_containers_fetch_output#Retrieve the output data produced by a specific PhantomBuster container execution. The output can be returned as structured JSON or as raw plain text depending on the mode parameter.2 params▾

Retrieve the output data produced by a specific PhantomBuster container execution. The output can be returned as structured JSON or as raw plain text depending on the mode parameter.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the container whose output to retrieve. Required.

modestringoptionalOutput format mode. Set to 'json' (default) to receive structured JSON output, or 'raw' to receive the output as plain text.

phantombustermcp_containers_fetch_result_object#Retrieve the result object associated with a specific PhantomBuster container execution. The result object contains structured data about the outcome of the container run, including extracted data and execution summary.1 param▾

Retrieve the result object associated with a specific PhantomBuster container execution. The result object contains structured data about the outcome of the container run, including extracted data and execution summary.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the container whose result object to retrieve. Required.

phantombustermcp_icps_fetch_all#Fetch all Ideal Customer Profiles (ICPs) configured for the authenticated organization. Returns the complete list of ICP definitions used for lead scoring and targeting.0 params▾

Fetch all Ideal Customer Profiles (ICPs) configured for the authenticated organization. Returns the complete list of ICP definitions used for lead scoring and targeting.

phantombustermcp_identities_events_save#Save an event associated with an identity. Records an event of a specific type for a given profile ID, with arbitrary event data and an optional timestamp.5 params▾

Save an event associated with an identity. Records an event of a specific type for a given profile ID, with arbitrary event data and an optional timestamp.

NameTypeRequiredDescription

event_dataobjectrequiredThe event data of the identity event. Required. A free-form key-value map with event details.

event_typestringrequiredThe type of the identity event. Required.

identity_typestringrequiredThe identity type of the identity event. Required.

profile_idstringrequiredThe profile id of the identity event. Must be non-empty and not whitespace-only. Required.

timestampnumberoptionalOptional timestamp of the identity event in milliseconds since epoch. Must be between 1000000000000 and 9999999999999.

phantombustermcp_identities_generate_token#Generate a new identity token for the authenticated session. This token can be used with the identities_save_with_token tool to associate a session token with an identity record.0 params▾

Generate a new identity token for the authenticated session. This token can be used with the identities_save_with_token tool to associate a session token with an identity record.

phantombustermcp_identities_save#Save an identity record. Creates or updates a LinkedIn or Google identity with profile information such as name, profile URL, headline, and subscription titles.10 params▾

Save an identity record. Creates or updates a LinkedIn or Google identity with profile information such as name, profile URL, headline, and subscription titles.

NameTypeRequiredDescription

profileIdstringrequiredThe profile id of the identity to save. Required. Maximum 475 characters.

typestringrequiredThe type of the identity to save. Either 'linkedin' or 'google'. Required.

firstNamestringoptionalThe first name of the identity to save.

headlinestringoptionalThe headline of the identity to save.

idstringoptionalThe internal id of the identity to save.

lastNamestringoptionalThe last name of the identity to save.

profilePictureUrlstringoptionalThe profile picture URL of the identity to save.

profileUrlstringoptionalThe profile URL of the identity to save.

subscriptionTitlesarrayoptionalSubscription titles of the identity to save. Can be a list of strings or null.

userIdstringoptionalThe user id of the identity to save.

phantombustermcp_identities_save_with_token#Save an identity record along with its authentication token and active credentials. Use this after generating a token with identities_generate_token to persist the full identity including session cookies.14 params▾

Save an identity record along with its authentication token and active credentials. Use this after generating a token with identities_generate_token to persist the full identity including session cookies.

NameTypeRequiredDescription

orgIdstringrequiredThe org_id of the identity to save. Required.

profileIdstringrequiredThe profile id of the identity to save. Required. Maximum 475 characters.

tokenstringrequiredThe identity token. Required. Obtain from identities_generate_token.

typestringrequiredThe type of the identity to save. Either 'linkedin' or 'google'. Required.

activeCredentialobjectoptionalThe active credential of the identity. Will replace activeCredentials in future versions.

activeCredentialsarrayoptionalActive credentials of the identity to save. Deprecated — will be removed soon. Use activeCredential instead.

firstNamestringoptionalThe first name of the identity to save.

headlinestringoptionalThe headline of the identity to save.

idstringoptionalThe internal id of the identity to save.

lastNamestringoptionalThe last name of the identity to save.

profilePictureUrlstringoptionalThe profile picture URL of the identity to save.

profileUrlstringoptionalThe profile URL of the identity to save.

subscriptionTitlesarrayoptionalSubscription titles of the identity to save. Can be a list of strings or null.

userIdstringoptionalThe user id of the identity to save.

phantombustermcp_identities_search#Search for identities by ID, session cookie, profile ID, or identity type. Returns matching identity records. Defaults to LinkedIn identity type when type is omitted.4 params▾

Search for identities by ID, session cookie, profile ID, or identity type. Returns matching identity records. Defaults to LinkedIn identity type when type is omitted.

NameTypeRequiredDescription

idstringoptionalThe internal id of the identity to search.

profileIdstringoptionalThe profile id of the identity to search.

sessionCookiestringoptionalSession cookie to search by.

typestringoptionalThe type of identity to search. Defaults to 'linkedin' when omitted.

phantombustermcp_org_storage_companies_objects_save#Save one company object to org storage. Creates or updates a single company record identified by its LinkedIn company ID, type, and slug.6 params▾

Save one company object to org storage. Creates or updates a single company record identified by its LinkedIn company ID, type, and slug.

NameTypeRequiredDescription

linkedinCompanyIdstringrequiredThe external id of the company scraped from LinkedIn. Required.

propertiesobjectrequiredThe properties of the company object. Required. A free-form key-value map of company attributes.

slugstringrequiredThe slug of the company object. Maximum 470 characters. Required.

typestringrequiredThe type of company object. Maximum 500 characters. Required.

idstringoptionalThe internal id of the company object.

orgIdstringoptionalThe org id associated with the company object.

phantombustermcp_org_storage_companies_objects_save_many#Save many company objects to org storage in a single batch operation. Each item in the array represents a company record to create or update.1 param▾

Save many company objects to org storage in a single batch operation. Each item in the array represents a company record to create or update.

NameTypeRequiredDescription

itemsarrayrequiredArray of company objects to insert or update. Required.

phantombustermcp_org_storage_companies_objects_search#Search company objects in org storage using a filter expression and optional pagination. Supports complex AND/OR filter trees. Use the org_storage_filter_help tool for the full operator and field reference.2 params▾

Search company objects in org storage using a filter expression and optional pagination. Supports complex AND/OR filter trees. Use the org_storage_filter_help tool for the full operator and field reference.

NameTypeRequiredDescription

filterobjectrequiredFilter object for querying company objects. ALWAYS wrap in a top-level { "and": [ ... ] }, even for a single condition. Company entity filter keys are mostly camelCase (e.g. employeeCount, websiteUrl). For the full operator reference, call the org_storage_filter_help tool. Required.

paginationOptionsobjectoptionalPagination options for the search results.

phantombustermcp_org_storage_filter_help#Returns the full reference for constructing org-storage filter objects: operator table, field lists for lead and company entities, lead-object property-change patterns, social-signal patterns, common pitfalls (boolean fields, regions, multi-field property changes), and worked examples. Call this when you need to build or edit the `filter` field on any org-storage tool (e.g. org_storage_lists_save, org_storage_leads_objects_search, org_storage_companies_objects_search) and the short pointer description on that field is not enough.0 params▾

Returns the full reference for constructing org-storage filter objects: operator table, field lists for lead and company entities, lead-object property-change patterns, social-signal patterns, common pitfalls (boolean fields, regions, multi-field property changes), and worked examples. Call this when you need to build or edit the `filter` field on any org-storage tool (e.g. org_storage_lists_save, org_storage_leads_objects_search, org_storage_companies_objects_search) and the short pointer description on that field is not enough.

phantombustermcp_org_storage_leads_by_list_listid#Fetch leads by their list id.4 params▾

Fetch leads by their list id.

NameTypeRequiredDescription

listIdstringrequiredId of the lead list.

paginationOptionsobjectoptionalOptions for pagination

withCompaniesbooleanoptionalOption for retrieving the company associated to the lead

withLeadObjectsOfTypesarrayoptionalArray of lead object types

phantombustermcp_org_storage_leads_delete_many#Delete many leads.1 param▾

Delete many leads.

NameTypeRequiredDescription

idsarrayrequiredIds of the leads to delete

phantombustermcp_org_storage_leads_objects_delete#Delete one or more leads objects.3 params▾

Delete one or more leads objects.

NameTypeRequiredDescription

leadObjectIdstringoptionalid of a lead object to delete

slugstringoptionalslug of the object to delete

typestringoptionaltype of object to delete

phantombustermcp_org_storage_leads_objects_save#Save one lead object.8 params▾

Save one lead object.

NameTypeRequiredDescription

agentIdstringrequiredid of an agent

propertiesobjectrequiredproperties of the object

slugstringrequiredslug of the object to save

typestringrequiredtype of object to save

leadIdstringoptionalid of a lead

leadObjectIdstringoptionalid of a lead object

leadSlugstringoptionalslug of a lead

leadUrnstringoptionalurn of a lead

phantombustermcp_org_storage_leads_objects_save_many#Save many lead objects.8 params▾

Save many lead objects.

NameTypeRequiredDescription

agentIdstringrequiredid of an agent

propertiesobjectrequiredproperties of the object

slugstringrequiredslug of the object to save

typestringrequiredtype of object to save

leadIdstringoptionalid of a lead

leadObjectIdstringoptionalid of a lead object

leadSlugstringoptionalslug of a lead

leadUrnstringoptionalurn of a lead

phantombustermcp_org_storage_leads_objects_search#Search leads objects.3 params▾

Search leads objects.

NameTypeRequiredDescription

filterstringrequiredFilter object for org-storage queries (leads, companies, lead_objects, company_objects). ALWAYS wrap in a top-level { "and": [ ... ] }, even for a single condition (bare { filter: ... } at the top will not render). Field keys are plain identifiers — write "location", not "lead.location"; the entity is set via the entity property inside the operator clause. Casing matters: lead/lead_object filter keys are snake_case (linkedin_job_title, NOT linkedinJobTitle); company entity filter keys are mostly camelCase (employeeCount, websiteUrl). For the full operator reference, field lists, frontend-compat rules, and worked examples, call the org_storage_filter_help tool.

paginationOptionsobjectoptionalPagination options

withLeadsbooleanoptionalWhether to include the parent lead data in the result

phantombustermcp_org_storage_leads_save#Saves a single lead to PhantomBuster organization storage (Beta). Requires a LinkedIn profile URL. Supports enrichment fields including contact info, company details, CRM account mappings, and AI-generated properties.18 params▾

Saves a single lead to PhantomBuster organization storage (Beta). Requires a LinkedIn profile URL. Supports enrichment fields including contact info, company details, CRM account mappings, and AI-generated properties.

NameTypeRequiredDescription

linkedinProfileUrlstringrequiredLinkedIn profile URL of the lead. Required.

companyIndustrystringoptionalIndustry of the lead's company.

companyNamestringoptionalLead's current company name.

companyWebsitestringoptionalLead's company website URL.

errorstringoptionalError message from the agent script, if any.

firstNamestringoptionalLead's first name.

lastNamestringoptionalLead's last name.

linkedinCompanySlugstringoptionalLead's company LinkedIn slug identifier.

linkedinDescriptionstringoptionalLead's LinkedIn profile description/summary.

linkedinHeadlinestringoptionalLead's LinkedIn profile headline.

linkedinJobTitlestringoptionalLead's current job title from LinkedIn.

linkedinProfileIdstringoptionalLead's LinkedIn profile ID.

locationstringoptionalLead's geographic location.

personalEmailsarrayoptionalLead's personal email addresses.

phoneNumbersarrayoptionalLead's phone numbers.

professionalEmailsarrayoptionalLead's professional email addresses.

salesNavigatorProfileUrlstringoptionalLead's LinkedIn Sales Navigator profile URL.

twitterProfileUrlstringoptionalLead's Twitter/X profile URL.

phantombustermcp_org_storage_leads_save_many#Saves multiple leads to PhantomBuster organization storage (Beta). Accepts a batch of 1-20 leads with LinkedIn profile URLs and associated metadata. Each lead must include a LinkedIn profile URL.1 param▾

Saves multiple leads to PhantomBuster organization storage (Beta). Accepts a batch of 1-20 leads with LinkedIn profile URLs and associated metadata. Each lead must include a LinkedIn profile URL.

NameTypeRequiredDescription

leadsarrayrequiredArray of 1-20 lead objects to save. Each lead must have a linkedinProfileUrl.

phantombustermcp_org_storage_lists_delete#Delete a list (Beta).1 param▾

Delete a list (Beta).

NameTypeRequiredDescription

idstringrequiredId of the list to delete

phantombustermcp_org_storage_lists_fetch#Get one list by ID (Beta).1 param▾

Get one list by ID (Beta).

NameTypeRequiredDescription

idstringrequiredId of the lead list to fetch.

phantombustermcp_org_storage_lists_fetch_all#Get all the lists (Beta).0 params▾

Get all the lists (Beta).

phantombustermcp_org_storage_lists_save#Save a list (Beta). Creates a new list or updates an existing one. For more information, see the Creating and updating leads lists using filters page in the Developer Guides.6 params▾

Save a list (Beta). Creates a new list or updates an existing one. For more information, see the Creating and updating leads lists using filters page in the Developer Guides.

NameTypeRequiredDescription

filterstringrequiredFilter object for org-storage queries (leads, companies, lead_objects, company_objects). ALWAYS wrap in a top-level { "and": [ ... ] }, even for a single condition (bare { filter: ... } at the top will not render). Field keys are plain identifiers — write "location", not "lead.location"; the entity is set via the entity property inside the operator clause. Casing matters: lead/lead_object filter keys are snake_case (linkedin_job_title, NOT linkedinJobTitle); company entity filter keys are mostly camelCase (employeeCount, websiteUrl). For the full operator reference, field lists, frontend-compat rules, and worked examples, call the org_storage_filter_help tool.

namestringrequiredName of the list (1-100 chars)

descriptionstringoptionalDescription of the list

idstringoptionalID of an existing list (omit to create a new one)

listProcessorConfigurationobjectoptionalList processor configuration object (free-form)

tagsarrayoptionalTags for the list

phantombustermcp_orgs_export_agent_usage#Exports a CSV file containing agent usage data for the current user's organization. The export includes details on how agents have been used over the specified number of days. The number of days should not exceed 6 months (approximately 180 days).1 param▾

Exports a CSV file containing agent usage data for the current user's organization. The export includes details on how agents have been used over the specified number of days. The number of days should not exceed 6 months (approximately 180 days).

NameTypeRequiredDescription

daysstringrequiredNumber of days of agent usage data to export. Must not exceed 6 months (approximately 180 days).

phantombustermcp_orgs_export_container_usage#Exports a CSV file containing container usage data for the current user's organization. The export includes details on container execution over the specified number of days. Optionally filter by a specific agent ID. The number of days should not exceed 6 months (approximately 180 days).2 params▾

Exports a CSV file containing container usage data for the current user's organization. The export includes details on container execution over the specified number of days. Optionally filter by a specific agent ID. The number of days should not exceed 6 months (approximately 180 days).

NameTypeRequiredDescription

daysstringrequiredNumber of days of container usage data to export. Must not exceed 6 months (approximately 180 days).

agentIdstringoptionalIf set, the data will only be exported for this specific agent ID.

phantombustermcp_orgs_fetch#Retrieves the current organization's details including account information, settings, and plan data. Optionally returns the organization's global object, proxy configurations, CRM integrations, and custom AI prompts.4 params▾

Retrieves the current organization's details including account information, settings, and plan data. Optionally returns the organization's global object, proxy configurations, CRM integrations, and custom AI prompts.

NameTypeRequiredDescription

withCrmIntegrationsstringoptionalIf set, the organization's CRM integration configurations will be returned in the response.

withCustomPromptsstringoptionalIf set, the organization's custom AI prompt (customPromptOrg) will be returned in the response.

withGlobalObjectstringoptionalIf set, the organization's globalObject will be returned in the response.

withProxiesstringoptionalIf set, the organization's proxy pool configurations will be returned in the response.

phantombustermcp_orgs_fetch_agent_groups#Retrieves the agent groups and their ordering for the current user's organization. Returns the full list of agent groups with their names, IDs, and the agents assigned to each group.0 params▾

Retrieves the agent groups and their ordering for the current user's organization. Returns the full list of agent groups with their names, IDs, and the agents assigned to each group.

phantombustermcp_orgs_fetch_crm_access#Retrieve the CRM access credentials and connection details for the authenticated organization. Use this to verify CRM connectivity before attempting to fetch CRM resources.0 params▾

Retrieve the CRM access credentials and connection details for the authenticated organization. Use this to verify CRM connectivity before attempting to fetch CRM resources.

phantombustermcp_orgs_fetch_crm_resources#Retrieve a specific type of CRM resource for the authenticated organization. Supports fetching account info, contact lists, or contact properties depending on the specified resource type.1 param▾

Retrieve a specific type of CRM resource for the authenticated organization. Supports fetching account info, contact lists, or contact properties depending on the specified resource type.

NameTypeRequiredDescription

resourceTypestringrequiredThe type of CRM resource to retrieve from the organization. Must be one of: 'account_info', 'contact_lists', or 'contact_properties'.

phantombustermcp_orgs_fetch_resources#Retrieves the current organization's resource allocations and usage statistics. Returns information about available and consumed resources such as agent execution time, storage, and other plan-based limits.0 params▾

Retrieves the current organization's resource allocations and usage statistics. Returns information about available and consumed resources such as agent execution time, storage, and other plan-based limits.

phantombustermcp_orgs_fetch_running_containers#Retrieve all currently running containers for the authenticated organization. Returns a list of active container instances, including their IDs, statuses, and associated agent information.0 params▾

Retrieve all currently running containers for the authenticated organization. Returns a list of active container instances, including their IDs, statuses, and associated agent information.

phantombustermcp_orgs_save#Updates the current organization's profile and settings. Allows modifying the organization name, display name, timezone, company info, billing details, proxy pools, CRM integration options, and custom AI prompt. Only web or MCP sessions are allowed to call this endpoint. Do not include the X-Phantombuster-Org header when calling this endpoint.14 params▾

Updates the current organization's profile and settings. Allows modifying the organization name, display name, timezone, company info, billing details, proxy pools, CRM integration options, and custom AI prompt. Only web or MCP sessions are allowed to call this endpoint. Do not include the X-Phantombuster-Org header when calling this endpoint.

NameTypeRequiredDescription

additionalInvoiceInformationstringoptionalAdditional information to include on invoices (max 100 characters). Set to null to clear.

billingAddressstringoptionalNew billing address for the organization. Provide an object with street, city, zip, and countryCode, or null to clear.

billingFirstNamestringoptionalNew billing contact first name for the organization. Set to null to clear.

billingLastNamestringoptionalNew billing contact last name for the organization. Set to null to clear.

billingMailstringoptionalNew billing email address for the organization. Set to null to clear.

companystringoptionalNew company name for the organization (max 100 characters). Set to null to clear.

crmIntegrationOptionsobjectoptionalCRM integration options for the organization.

customPromptOrgstringoptionalCustom AI prompt at the workspace/organization level (max 10000 characters). Set to null to clear.

displayNamestringoptionalNew display name for the organization (max 100 characters).

globalObjectstringoptionalNew global object for the organization shared across all agents. Set to null to clear.

namestringoptionalNew internal organization name (max 100 characters).

proxiesstringoptionalNew proxy pool configuration for the organization. Set to null to clear.

timezonestringoptionalNew timezone for the organization (max 100 characters). Changing the timezone affects automatic agent scheduling.

vatIdstringoptionalNew VAT ID for the organization (max 100 characters). Set to null to clear.

phantombustermcp_orgs_save_agent_groups#Updates the agent groups and their ordering for the current user's organization. The order of the groups and agents within each group will be preserved as provided. Each group can be referenced either by its string ID or as a full object with id, name, and agents array.1 param▾

Updates the agent groups and their ordering for the current user's organization. The order of the groups and agents within each group will be preserved as provided. Each group can be referenced either by its string ID or as a full object with id, name, and agents array.

NameTypeRequiredDescription

agentGroupsarrayrequiredNew agent groups configuration. Order of groups and agents within each group will be preserved. Each item can be a group ID string or a full group object with id, name, and agents.

phantombustermcp_orgs_save_crm_contact#Save a new contact to a connected CRM integration (currently HubSpot). Creates or updates a contact record with profile information such as name, LinkedIn URL, email, phone, job title, and company.2 params▾

Save a new contact to a connected CRM integration (currently HubSpot). Creates or updates a contact record with profile information such as name, LinkedIn URL, email, phone, job title, and company.

NameTypeRequiredDescription

contactobjectrequiredContact information for creation or update. Required.

crmNamestringrequiredThe CRM integration name. Currently only 'hubspot' is supported. Required.

phantombustermcp_scripts_access_list#Updates the access list of a script branch on PhantomBuster. Allows adding or removing an organization or user from the script's access list.4 params▾

Updates the access list of a script branch on PhantomBuster. Allows adding or removing an organization or user from the script's access list.

NameTypeRequiredDescription

branchstringrequiredName of the branch to update the access list for.

namestringrequiredName of the script to update the access list for. Must match pattern like 'myscript.js'.

addstringoptionalOrganization or user slug to add to the access list. Optional.

removestringoptionalOrganization or user slug to remove from the access list. Optional.

phantombustermcp_scripts_code#Gets the source code of a PhantomBuster script by name. Optionally fetch from a specific organization, branch, or environment (staging or release).4 params▾

Gets the source code of a PhantomBuster script by name. Optionally fetch from a specific organization, branch, or environment (staging or release).

NameTypeRequiredDescription

scriptstringrequiredName of the script file to fetch, including extension. Must match the pattern for .js or .coffee files (e.g. 'my-script.js').

branchstringoptionalIf set, the specified branch will be used to fetch the script code.

environmentstringoptionalIf set, the specified environment will be used to fetch the script code. Accepted values: 'staging', 'release'.

orgstringoptionalIf set, the specified organization will be used to fetch the script code.

phantombustermcp_scripts_delete#Deletes a PhantomBuster script by its ID. This action is irreversible. Optionally specify a branch and environment to target a specific version.3 params▾

Deletes a PhantomBuster script by its ID. This action is irreversible. Optionally specify a branch and environment to target a specific version.

NameTypeRequiredDescription

idstringrequiredID of the script to delete.

branchstringoptionalBranch of the script to delete. Optional.

environmentstringoptionalEnvironment of the script to delete. Either 'staging' or 'release'.

phantombustermcp_scripts_fetch#Gets a PhantomBuster script by its ID. Optionally retrieve the script from a specific branch or environment, and include the script's source code in the response.4 params▾

Gets a PhantomBuster script by its ID. Optionally retrieve the script from a specific branch or environment, and include the script's source code in the response.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the script to fetch.

branchstringoptionalIf set, the script will be retrieved from the specified branch. Must be 1-50 characters of word characters and hyphens.

environmentstringoptionalIf set, the script will be retrieved from the specified environment. Accepted values: 'staging', 'release'.

withCodestringoptionalIf set, the script's source code will be included in the response. Accepted values: 'staging', 'release'.

phantombustermcp_scripts_fetch_all#Gets all scripts associated with the current user. Optionally filter by organization, branch, script type (modules vs non-modules), or specific script IDs.4 params▾

Gets all scripts associated with the current user. Optionally filter by organization, branch, script type (modules vs non-modules), or specific script IDs.

NameTypeRequiredDescription

branchstringoptionalIf set, only scripts from the specified branch will be fetched. Must be 1-50 word characters or hyphens.

excludestringoptionalFilter script types to return. Set to 'modules' to exclude module scripts, or 'non-modules' to return only module scripts.

orgstringoptionalName of the organization to fetch scripts from. If not set, scripts from the current user's default organization are returned.

scriptIdsarrayoptionalIf set, only the specified script IDs will be retrieved. Accepts an array (0-100 items) or a comma-separated string of IDs.

phantombustermcp_scripts_save#Creates a new script or updates an existing one on PhantomBuster. If an id is provided, the corresponding script will be updated. Otherwise, a new script will be created.5 params▾

Creates a new script or updates an existing one on PhantomBuster. If an id is provided, the corresponding script will be updated. Otherwise, a new script will be created.

NameTypeRequiredDescription

branchstringoptionalName of the branch to associate with the script. Optional.

codestringoptionalJavaScript source code of the script. Maximum 600,000 characters.

idstringoptionalIf set, the script with the corresponding id will be updated. Leave blank to create a new script.

markdownstringoptionalMarkdown documentation for the script. Maximum 200,000 characters.

namestringoptionalName of the script file. Prepend with 'lib-' to define as a module. Must end in .js or .coffee.

phantombustermcp_scripts_visibility#Updates the visibility of a script branch on PhantomBuster. Controls whether the script is private, semi-public, public, semi open source, or open source.3 params▾

Updates the visibility of a script branch on PhantomBuster. Controls whether the script is private, semi-public, public, semi open source, or open source.

NameTypeRequiredDescription

branchstringrequiredName of the branch to change visibility for.

namestringrequiredName of the script to change visibility for. Must match pattern like 'myscript.js' or 'my-script.coffee'.

visibilitystringrequiredNew visibility level to set for the branch. Options: private, semi public, public, semi open source, open source.

phantombustermcp_users_fetch_me#Retrieves the current authenticated user's profile information including account details and session data. If a sessionId is not provided, the endpoint will create a new session and return the newly created session ID. Optionally returns detailed organization info and custom AI prompts.2 params▾

Retrieves the current authenticated user's profile information including account details and session data. If a sessionId is not provided, the endpoint will create a new session and return the newly created session ID. Optionally returns detailed organization info and custom AI prompts.

NameTypeRequiredDescription

detailedOrgIdstringoptionalIf set, the corresponding detailed organization object will be returned in the response.

withCustomPromptsstringoptionalIf set to "true", includes customPromptUser and customPromptOrg fields in the response.

phantombustermcp_users_update_me#Updates the current authenticated user's profile information. Allows modifying personal details such as name, phone, company, job title, team, and preferences including newsletter subscription, developer mode, and beta experiments. Also supports setting a custom AI prompt at the user level.14 params▾

Updates the current authenticated user's profile information. Allows modifying personal details such as name, phone, company, job title, team, and preferences including newsletter subscription, developer mode, and beta experiments. Also supports setting a custom AI prompt at the user level.

NameTypeRequiredDescription

companystringoptionalNew company name for the user (max 100 characters). Set to null to clear.

customPromptUserstringoptionalCustom AI prompt at the user level (max 10000 characters). Set to null to clear.

developerModebooleanoptionalIf set to true, developer-specific features will be enabled for the user.

enabledExperimentsstringoptionalList of beta experiments to enable on the user's account. Valid values: hubspotWidget, stepSetup, myPhantoms, navbar, seeBetaPhantoms, showCompatiblePhantomsLink, advancedChat. Set to null to clear.

firstNamestringoptionalNew first name for the user (max 100 characters).

jobstringoptionalNew job title for the user (max 100 characters). Set to null to clear.

lastNamestringoptionalNew last name for the user (max 100 characters).

newsletterbooleanoptionalIf set to true, the user agrees to subscribe to the PhantomBuster newsletter.

phonestringoptionalNew phone number for the user (max 100 characters). Set to null to clear.

userCompanySizestringoptionalNew company size for the user (max 100 characters). Set to null to clear.

userGoalstringoptionalNew primary goal for the user (max 100 characters). Set to null to clear.

userMainPlatformstringoptionalNew main platform for the user (max 100 characters). Set to null to clear.

userReferralSourcestringoptionalHow the user heard about PhantomBuster (max 100 characters). Set to null to clear.

userTeamstringoptionalNew team name for the user (max 100 characters). Set to null to clear.