Get a managed connection
This page needs your own installation with an Embed license.
GET/
Returns one connection you manage, by your key. Never a secret.
Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.
Parameters
Path
accountIdRequired · stringYour ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain
/.connectionKeyRequired · stringYour key for the connection: 1 to 255 bytes, unique in its workspace. URL-encode it.
Query
workspaceIdOptional · stringThe workspace, by your ID. Left out: the default workspace.
Responses
- 200OK
The connection.
A parameter isn’t valid.
details.fieldnames it.- 404
NOT_FOUNDNo such account, workspace or connection key.
Something failed on the installation’s side. Try again.
Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 429 RATE_LIMITED · 503 BUSY. See Errors.
Request
GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY" # gre_…
ACCOUNT_ID="acct-bakery"
CONNECTION_KEY="sheets-main"
URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}connections/$CONNECTION_KEY"
curl "$URL" \
-H "Authorization: Bearer $GORUNNER_EMBED_KEY"const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const ACCOUNT_ID = encodeURIComponent("acct-bakery");
const CONNECTION_KEY = encodeURIComponent("sheets-main");
const res = await fetch(
`${GORUNNER}/api/embed/v1/accounts/` +
`${ACCOUNT_ID}/connections/${CONNECTION_KEY}`,
{
headers: { Authorization: `Bearer ${KEY}` },
},
);
const { data } = await res.json();import os, requests
from urllib.parse import quote
GORUNNER = "https://automations.example.com"
KEY = os.environ["GORUNNER_EMBED_KEY"] # gre_…
ACCOUNT_ID = quote("acct-bakery", safe="")
CONNECTION_KEY = quote("sheets-main", safe="")
res = requests.get(
f"{GORUNNER}/api/embed/v1/accounts/"
f"{ACCOUNT_ID}/connections/{CONNECTION_KEY}",
headers={"Authorization": f"Bearer {KEY}"},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"key": "sheets-main",
"id": "0f8b2c7e-4a51-4d3e-9b2a-6c1d2e3f4a5b",
"name": "Google Sheets (Bakery)",
"pieceId": "googlesheets",
"status": "ok",
"managedBy": "partner",
"workspace": {
"id": null,
"default": true
},
"createdAt": "2026-10-20T08:00:00Z",
"updatedAt": "2026-10-25T09:00:00Z"
}
}Every field
It takes no body.
Response · 200 OK
dataobjectNever carries a secret.
keystring or nullThe partner’s key; null for one the customer made.
idUUIDnamestringpieceIdstringstatusstringexpired: its tokens can no longer be refreshed; replace them.One of
ok,error,expired.managedBystringOne of
partner,customer.workspaceobjectidstring or nullThe partner’s workspace id; null for the default workspace.
defaultbooleancreatedAttimeupdatedAttime