Docs

Agiliron API Authentication

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

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

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

Set up Agiliron API Key

You need an Agiliron admin account with access to API Key controls.

  1. Open API Key Access Controls

    Sign in to Agiliron Admin, then open Settings and go to API Key Access Controls (API v40+).

  2. Create a new API key

    Create a key for MindCloud integration and keep permissions scoped to the modules you need.

  3. Copy credentials into MindCloud connection

    Use your company subdomain and API key when creating the Agiliron 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.