# 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](https://docs.gorunner.io/embed/platform-screens#partner-keys). Call it from your server only.

Embed · Self-hosted with an Embed license

## Parameters

### Path

- `accountId` · Required · string: Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain `/`.
- `workspaceId` · Required · string: Your ID for the workspace. The word `default` names the account’s default workspace.

## Responses

- 200 OK

  The workspace.

- 400 `VALIDATION_ERROR`

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

- 404 `NOT_FOUND`

  No such account, or no such workspace in it.

- 500 `INTERNAL_ERROR`

  Something failed on the installation’s side. Try again.

Any call can also answer: [`401 UNAUTHORIZED`](https://docs.gorunner.io/errors#UNAUTHORIZED) · [`403 EMBED_NOT_LICENSED`](https://docs.gorunner.io/errors#EMBED_NOT_LICENSED) · [`403 IP_NOT_ALLOWED`](https://docs.gorunner.io/errors#IP_NOT_ALLOWED) · [`429 RATE_LIMITED`](https://docs.gorunner.io/errors#RATE_LIMITED) · [`503 BUSY`](https://docs.gorunner.io/errors#BUSY). See [Errors](https://docs.gorunner.io/embed/api#errors).

Request

**curl**

```bash
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"
```

**JavaScript**

```js
const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const ACCOUNT_ID = encodeURIComponent("acct-bakery");
const WORKSPACE_ID = encodeURIComponent("ws-orders");

const res = await fetch(
  `${GORUNNER}/api/embed/v1/accounts/` +
    `${ACCOUNT_ID}/workspaces/${WORKSPACE_ID}`,
  {
    headers: { Authorization: `Bearer ${KEY}` },
  },
);
const { data } = await res.json();
```

**Python**

```python
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="")
WORKSPACE_ID = quote("ws-orders", safe="")

res = requests.get(
    f"{GORUNNER}/api/embed/v1/accounts/"
    f"{ACCOUNT_ID}/workspaces/{WORKSPACE_ID}",
    headers={"Authorization": f"Bearer {KEY}"},
)
data = res.json()["data"]
```

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

- `data` · object
  - `id` · string or null: The partner’s workspace id; null for the default workspace.
  - `default` · boolean
  - `name` · string
  - `members` · integer
  - `createdAt` · time
  - `workspaceId` · UUID: The installation’s own id of the workspace, for support. Elsewhere `workspaceId` is the partner’s id (`id` here).

Related: [List workspaces](https://docs.gorunner.io/embed/api/workspaces/list-workspaces)

Source: https://docs.gorunner.io/embed/api/workspaces/get-workspace