Docs

Agile CRM API Authentication

How to authenticate Agile CRM API requests: one Bearer API key plus a connectionId. MindCloud stores your Agile CRM credentials — no auth headers to build.

Every Agile CRM API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Agile CRM 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 Agile CRM connection in Connections. Agile CRM uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  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 Agile CRM account that should run the action. MindCloud stores and refreshes the Agile CRM 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 Contacts with an Agile CRM connection looks like this:

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

Set up your Agile CRM REST API credentials

You need access to an Agile CRM account. Agile CRM uses your login email address as the username and your REST API key as the password for API requests.

  1. Open API & Analytics in Agile CRM

    Sign in to Agile CRM, open Admin Settings, then go to API & Analytics and locate the API Key section.

    Admin Settings → API & Analytics → API Key

  2. Copy the REST API key

    If Agile CRM shows multiple keys, copy the one labeled for the REST client.

  3. Enter your Agile CRM credentials in MindCloud

    In the MindCloud connection form, use your Agile CRM email address as the username and paste the copied REST API key as the password.

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.