Sign inGet started
Docs
Get started

GatherUp API Authentication

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

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

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

GatherUp Bearer Token Setup

You need access to GatherUp API credentials for the account or client you want to connect.

  1. Sign in to GatherUp

    Open the GatherUp app and sign in with an account that can view API credentials.

  2. Copy your Bearer Token and Client ID

    Open Account Owner details and copy the Bearer Token and Client ID. GatherUp's bearer auth makes the hash or private-key flow unnecessary for this connection.

  3. Optional: copy an Agent ID for agency credentials

    If you use global agency credentials, add the agent number for the client you want to target. Leave Agent ID empty when you use client-specific credentials.

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.