GoRunner docs
Search or askSearch⌘K

Get a managed connection

GET/api/embed/v1/accounts/{accountId}/connections/{connectionKey}

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.

Embed · Self-hosted with an Embed license

Parameters

Path

accountIdRequired · string

Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain /.

connectionKeyRequired · string

Your key for the connection: 1 to 255 bytes, unique in its workspace. URL-encode it.

Query

workspaceIdOptional · string

The workspace, by your ID. Left out: the default workspace.

Responses

  • 200OK

    The connection.

  • A parameter isn’t valid. details.field names it.

  • No 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"

Response · 200 OK

json
{
  "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

dataobject

Never carries a secret.

keystring or null

The partner’s key; null for one the customer made.

idUUID
namestring
pieceIdstring
statusstring

expired: its tokens can no longer be refreshed; replace them.

One of ok, error, expired.

managedBystring

One of partner, customer.

workspaceobject
idstring or null

The partner’s workspace id; null for the default workspace.

defaultboolean
createdAttime
updatedAttime