TOPdesk API Authentication

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

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

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

Set up TOPdesk API credentials

Use a TOPdesk operator account that can create application tokens and has API permissions.

Sign in to your TOPdesk tenant
Open your TOPdesk operator login page and sign in with your operator account.
Create or open an API account
In TOPdesk, open the API account used for integrations and confirm it has access enabled.
Generate an application token
Under Application tokens, create a new token, copy it immediately, and store it securely. TOPdesk shows this value only once.
Confirm API permissions
Assign or verify permissions for REST API and Use application tokens for this account.
Use the credentials in MindCloud connection setup
When creating the MindCloud connection, enter the API login username and the generated application token.

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.