Sign inGet started
Docs
Get started

PhantomBuster API Authentication

How to authenticate PhantomBuster API requests: one Bearer API key plus a connectionId. MindCloud stores your API key securely — set it once, never resend it.

Every PhantomBuster API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your PhantomBuster account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a PhantomBuster connection in Connections. PhantomBuster uses an API key. You generate the key in your PhantomBuster account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected PhantomBuster account that should run the action. MindCloud stores and refreshes the PhantomBuster credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Branches with an PhantomBuster connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/phantomBuster/actions/list-branches/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which PhantomBuster account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

How to set up your PhantomBuster connection

You need access to a PhantomBuster workspace. Have permission to open Workspace settings and be ready to copy the API key immediately when it is shown.

  1. Open Workspace settings in PhantomBuster

    Sign in to PhantomBuster, open the navbar menu, and choose Workspace settings.

  2. Create or reveal an API key

    In Workspace settings, find your API key. If you need a new one, generate a new API key there.

  3. Copy the API key and store it safely

    PhantomBuster says the key is only shown once, on creation, for security reasons. Copy it before refreshing or leaving the page.

  4. Paste the API key into MindCloud

    Return to this connection form and paste the value into the API Key field.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.