Clientary API Authentication

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

Every Clientary API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Clientary 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

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Clientary connection in Connections. Clientary uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
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 Clientary account that should run the action. MindCloud stores and refreshes the Clientary 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 Clients with an Clientary connection looks like this:

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

Connect Clientary

You need your Clientary account subdomain and an API token from your Clientary user profile.

Sign in to Clientary
Log in to the Clientary account you want to connect.
Open your user profile
After you log in, open your user profile from the upper-right corner of Clientary.
User profile
Generate an API token
Click Generate API Token, then copy the token somewhere safe so you can paste it into the connection form.
Enter your subdomain
In the MindCloud connection form, enter the part of your Clientary URL that comes before .clientary.com in the Subdomain field.
Paste the token into both credential fields
Paste the same Clientary API token into the Username and Password fields in MindCloud.
Test the connection
Save or test the connection in MindCloud to confirm the subdomain and API token are correct.

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.