Sign inGet started
Docs
Get started

Planfix API Authentication

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

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

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

Connect Planfix

You need a Planfix account URL and a REST API token.

  1. Open your Planfix account settings

    Sign in to Planfix, then open Account Management and find Access to API.

  2. Create or copy a REST API token

    In Access to API, create a REST API token or copy an existing one. Grant the scopes your workflows need.

  3. Copy your account base URL

    Copy your Planfix workspace URL from the browser address bar, for example https://your-account.planfix.com or https://your-account.planfix.us. Do not include /rest.

  4. Enter both values in MindCloud

    Paste the Account Base URL and the API Key into the connection form.

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.