Docs

VSCO Workspace API Authentication

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

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

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

Connect VSCO Workspace

You need a VSCO Workspace account with Public API access.

  1. Open API Integrations in Workspace

    In your VSCO Workspace account, go to Settings > API Integrations.

    Settings → API Integrations

  2. Create a new API key

    Select New API Key and create a key for this connection.

  3. Choose the right permission level

    Pick Read Only for read-only use cases, or Read and Write only if you want Cirra to create or update records.

  4. Paste the key into MindCloud

    Copy the generated API key and paste it into the API Key field when creating the 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.