Docs

Courier API Authentication

How to authenticate Courier API requests: one Bearer API key plus a connectionId. MindCloud stores your Courier API key securely — set it once, never resend it.

Every Courier API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Courier 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 Courier connection in Connections. Courier uses an API key. You generate the key in your Courier account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  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 Courier account that should run the action. MindCloud stores and refreshes the Courier 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 with an Courier connection looks like this:

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Courier account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Courier with an API key

Sign in to the Courier workspace you want to connect. Use a test API key when you want Stage 1 and Stage 2 work to stay in Courier’s Test environment.

  1. Open API Keys

    In Courier, go to Settings > API Keys. Courier documents separate API keys for each environment.

    Settings → API Keys
  2. Copy the key for the environment you want to use

    Courier provides separate Test and Production keys. Choose a test key for safe scaffold and mapper work when possible.

  3. Paste the key into MindCloud and save the connection

    Use the copied Courier API key as the connection secret in MindCloud.

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.

Courier API Authentication - Universal API