GoRunner docs
Search or askSearch⌘K

Get a workspace

GET/api/embed/v1/accounts/{accountId}/workspaces/{workspaceId}

Returns one workspace of an account.

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 /.

workspaceIdRequired · string

Your ID for the workspace. The word default names the account’s default workspace.

Responses

  • 200OK

    The workspace.

  • The account or workspace ID isn’t allowed as written. details.field names it.

  • No such account, or no such workspace in it.

  • 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"
WORKSPACE_ID="ws-orders"

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}workspaces/$WORKSPACE_ID"
curl "$URL" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY"

Response · 200 OK

json
{
  "data": {
    "id": "ws-orders",
    "default": false,
    "name": "Orders",
    "members": 2,
    "createdAt": "2026-10-22T10:00:00Z",
    "workspaceId": "6e9a1c3f-8b2d-4a57-9e0c-3f7b5d1a8c42"
  }
}
Every field

It takes no body.

Response · 200 OK

dataobject
idstring or null

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

defaultboolean
namestring
membersinteger
createdAttime
workspaceIdUUID

The installation’s own id of the workspace, for support. Elsewhere workspaceId is the partner’s id (id here).