Sign inGet started
Docs
Get started

SurveySparrow API Authentication

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

Every SurveySparrow API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your SurveySparrow 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 SurveySparrow connection in Connections. SurveySparrow uses OAuth. When you create the connection, you are redirected to sign in to SurveySparrow 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 SurveySparrow account that should run the action. MindCloud stores and refreshes the SurveySparrow 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 Export Translation with an SurveySparrow connection looks like this:

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

Set up SurveySparrow OAuth2

Create or open a private app in SurveySparrow before connecting MindCloud. Use the same scopes that you want MindCloud to access.

  1. Open Apps & Integrations in SurveySparrow

    In your SurveySparrow account, go to Settings and then Apps & Integrations. Create a private app if you do not already have one.

  2. Add the MindCloud redirect URI

    Set the redirect URI to https://api.mindcloud.co/v1/oauth/surveySparrow/callback.

  3. Select the required scopes and save the private app

    Choose the SurveySparrow scopes you want MindCloud to use, save the private app, and keep the selected scopes aligned with the connection you create in MindCloud.

  4. Copy the client credentials

    Copy the client ID and client secret from the private app into the MindCloud connection flow when prompted.

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.