Docs

Hub Planner API Authentication

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

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

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

Connect Hub Planner

You need administrator privileges in Hub Planner to enable API access and generate an API key.

  1. Open API settings in Hub Planner

    Sign in to Hub Planner and navigate to Settings > API.

    Settings → API
  2. Enable API access

    Enable API access for the account if it is not already enabled.

  3. Generate an API key

    Generate either a Read Only or Read & Write API key depending on the actions you plan to run.

  4. Paste the API key into MindCloud

    Copy the generated key and paste it into the API Key field. Do not add the word Bearer; Hub Planner expects the raw key only.

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.