Sign inGet started
Docs
Get started

Avaza API Authentication

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

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

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

Create an Avaza OAuth app

You need an Avaza Administrator account and the MindCloud redirect URL.

  1. Open Developer Apps

    Sign in to Avaza and go to Settings > Manage Developer Apps.

    Settings → Manage Developer Apps

  2. Create an OAuth app

    Click Add OAuth App. Enter an app name and description, choose the Server-to-Server client type, and set the redirect URL to https://api.mindcloud.co/v1/oauth/avaza/callback.

  3. Choose the required scopes

    Select these scopes for the MindCloud wrapper: read_account, read_contacts, write_contacts, read_projects, write_projects, read_financials, write_financials, read_expenses, write_expenses, read_timesheets, write_timesheets.

  4. Save and copy the credentials

    Save the app, then copy the Client ID and App Secret immediately. Avaza only shows the App Secret once.

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.