Pinghome API Authentication

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

Every Pinghome API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Pinghome 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

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Pinghome connection in Connections. Pinghome uses an API key. You generate the key in your Pinghome account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
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 Pinghome account that should run the action. MindCloud stores and refreshes the Pinghome 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 Customer Profile with an Pinghome connection looks like this:

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

Get a Pinghome bearer token

You need a Pinghome account email and password. This connection expects the Pinghome access token value, not your password.

Open Pinghome sign in
Confirm you can sign in with the Pinghome account you want to connect.
Pinghome → Sign in
Request a bearer token from the Account Sign In endpoint
Follow Pinghome's Account Sign In documentation and send a POST request to https://auth.api.pinghome.io/v1/auth with your email and password in the JSON body.
Authentication → Account Sign In
Copy the access token
From the successful sign-in response, copy the access_token value. This is the bearer token MindCloud should store.
Paste the token into the MindCloud connection
Use the copied access token as the Pinghome connection credential 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.