Connecting to Phantombuster

Using API Key Authentication

To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Phantombuster API key from the account settings page.

Multi-Organization Accounts

If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

Example connection string:

Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

Available Tables

The Phantombuster API Profile provides access to automation workflow and data extraction resources across 13 tables:

• AgentGroups - Query agent groups defined in the Phantombuster organization.
• AgentOutput - Query the most recent execution output for a Phantombuster agent. Requires AgentId.
• Agents - Query Phantombuster agents, fetching all agents or a single agent by Id with extended fields.
• Branches - Query Phantombuster script branches available in the organization.
• ContainerResultObject - Query the result object returned by a specific container execution. Requires container Id.
• Containers - Query Phantombuster container executions. List by AgentId with cursor-based pagination, or fetch a single container by Id.
• DeletedAgents - Query Phantombuster agents that have been deleted from the organization.
• Lists - Query org-storage lists in Phantombuster.
• OrgResources - Query resource usage and quota limits for the authenticated Phantombuster organization.
• Organizations - Query the Phantombuster organization associated with the authenticated API key.
• RunningContainers - Query all currently active container executions across the entire Phantombuster organization.
• Scripts - Query Phantombuster scripts, fetching all scripts or a single script by Id with extended fields.
• User - Query the authenticated Phantombuster user account details.

Usage Examples

Agent Management

Get all agents:

SELECT * FROM Agents

Get a specific agent by Id:

SELECT * FROM Agents WHERE Id = 'your-agent-id'

Get all deleted agents:

SELECT * FROM DeletedAgents

Get all agent groups:

SELECT * FROM AgentGroups

Container Execution Monitoring

Get container runs for a specific agent:

SELECT * FROM Containers WHERE AgentId = 'your-agent-id'

Get container runs filtered by status:

SELECT * FROM Containers WHERE AgentId = 'your-agent-id' AND Status = 'finished'

Get all currently running containers across the organization:

SELECT * FROM RunningContainers

Get the most recent output for an agent:

SELECT * FROM AgentOutput WHERE AgentId = 'your-agent-id'

Get the result object for a specific container execution:

SELECT * FROM ContainerResultObject WHERE Id = 'your-container-id'

Script and Branch Management

Get all scripts:

SELECT * FROM Scripts

Get a specific script by Id:

SELECT * FROM Scripts WHERE Id = 'your-script-id'

Get all script branches:

SELECT * FROM Branches

Organization and Resource Monitoring

Get organization details:

SELECT * FROM Organizations

Get resource usage and quota limits:

SELECT * FROM OrgResources

User Account

Get the authenticated user details:

SELECT * FROM User

Org Storage Data

Get all lists from org storage:

SELECT * FROM Lists

Get a specific list by Id:

SELECT * FROM Lists WHERE Id = 'your-list-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your Phantombuster API key from the Phantombuster Console.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
OrganizationId	The identifier of the Phantombuster organization to target for multi-organization accounts.