Docs

Ontraport API Authentication

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

Every Ontraport API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Ontraport 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 Ontraport connection in Connections. Ontraport uses an API key. You generate the key in your Ontraport 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 Ontraport account that should run the action. MindCloud stores and refreshes the Ontraport 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 Retrieve Contact Object Meta with an Ontraport connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/ontraport/actions/retrieve-contact-object-meta/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 Ontraport account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Ontraport

You need an Ontraport account with API access.

  1. Open Ontraport API settings

    Sign in to Ontraport and open the Administration settings page where API credentials are managed.

    Administration settings
  2. Copy your API Key and App ID

    Create or reveal your API credentials, then copy the API Key and the App ID shown in Ontraport.

  3. Paste the credentials into MindCloud

    Enter your API Key in the API Key field and your App ID in the App ID field for this connection.

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.