Simpro API Authentication

How to authenticate Simpro API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes Simpro tokens for you.

Every Simpro API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Simpro 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 Simpro connection in Connections. Simpro uses OAuth. When you create the connection, you are redirected to sign in to Simpro and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
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 Simpro account that should run the action. MindCloud stores and refreshes the Simpro 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 Companies with an Simpro connection looks like this:

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

Set up Simpro OAuth 2.0

A Simpro administrator must request API access inside the Simpro build you want to connect. If you are not an administrator, ask yours to complete the application request and give you the Client ID and Client Secret.

Enter your Simpro build URL
In Build URL, enter the full address you use to sign in to Simpro, including https://, for example https://yourcompany.simprosuite.com. Do not enter only your company or build name.
Request API access
In Simpro, go to System > Setup. Near the bottom, open API, select Applications, and choose Request Access. If API is not available, ask a Simpro administrator to complete these steps.
System → Setup → API → Applications → Request Access
Use the exact redirect URL
When Simpro asks for the redirect URL, paste the callback URL exactly as shown here. The connection cannot complete if this value is different.
Copy the credentials when Simpro shows them
After the application is approved, Simpro issues a Client ID and Client Secret for this build. Paste them into Client ID and Client Secret in the connection form. Simpro shows the Client Secret only at this time, so copy it before leaving the page.
Connect Simpro
Return to the connection form, confirm Build URL, Client ID, and Client Secret are filled in, then start the connection and approve access in Simpro.

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.