Reamaze API Authentication

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

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

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

Connect your Reamaze account

You need the Reamaze brand slug from your account URL, the login email for the user who owns the API token, and that user's Reamaze API token.

Find your brand slug
Look at your Reamaze account URL. If your account URL is https://mindcloud.reamaze.com, enter mindcloud as the Brand value in this connection.
Reamaze account URL
Generate or copy an API token
In Reamaze, open Settings, then Developer, then API Token. Generate a new token or copy the existing token for the same user account you want MindCloud to act as.
Settings → Developer → API Token
Enter the connection values
Use that user's login email as the username, paste the API token as the password or token value, and enter your brand slug.

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.