Docs

Syncro API Authentication

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

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

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

Connect Syncro with an API key

You need admin access to the MindCloud Syncro tenant to generate an API key.

  1. Open the API settings in Syncro

    Sign in to the MindCloud Syncro account, then open Admin Settings > API.

  2. Generate or copy the API key

    Create an API key if one does not exist, or copy the existing API key shown on the API page.

  3. Paste the API key into the MindCloud connection

    When MindCloud asks for Syncro credentials, paste the API key into the API key field and save the 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.