Sign inGet started
Docs
Get started

Harvestr.io API Authentication

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

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

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

Create a Harvestr API access token

You need access to your Harvestr workspace settings.

  1. Open the Harvestr Public API settings

    Go to the Harvestr page where private app tokens are created.

    Settings → Integrations → Harvestr Public API
  2. Create an API Access Token

    Create a new token in Harvestr. The docs call this an Api Access Token.

  3. Select the scopes you need

    For the default connection test action in this wrapper, Message Read is enough. For the full Harvestr wrapper, choose the scopes that cover the actions you plan to use. The official scope matrix maps endpoints to read_customer, write_customer, read_attribute, write_attribute, read_discovery, write_discovery, read_feedback, create_feedback, and update_feedback.

  4. Copy the token into MindCloud

    Paste the token into the MindCloud API Key field for this Harvestr connection.

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.