# List workspaces

**GET** `/api/embed/v1/accounts/{accountId}/workspaces`

Lists an account’s workspaces, the default one first.

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

### Query

- `cursor` · Optional · string: The `pagination.nextCursor` of the page before. Left out: the first page.
- `limit` · Optional · integer: Rows a page, 1 to 100. The default is 50.

## Two IDs

`id` is yours; the default workspace has none (`null`). `workspaceId` is GoRunner’s, for support.

## Responses

- 200 OK

  A page of workspaces.

- 400 `VALIDATION_ERROR`

  A parameter isn’t valid.

- 404 `NOT_FOUND`

  You have no account with this ID.

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

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}workspaces"
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 res = await fetch(
  `${GORUNNER}/api/embed/v1/accounts/` +
    `${ACCOUNT_ID}/workspaces`,
  {
    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="")

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

Response · 200 OK

```json
{
  "data": [
    {
      "id": null,
      "default": true,
      "name": "Default Workspace",
      "members": 4,
      "createdAt": "2026-10-20T08:00:00Z",
      "workspaceId": "c41a7e02-9b3d-4f6a-8e15-7d2c0b9a4f68"
    },
    {
      "id": "ws-orders",
      "default": false,
      "name": "Orders",
      "members": 2,
      "createdAt": "2026-10-22T10:00:00Z",
      "workspaceId": "6e9a1c3f-8b2d-4a57-9e0c-3f7b5d1a8c42"
    }
  ],
  "pagination": {
    "limit": 50,
    "nextCursor": null
  }
}
```

**Every field**

It takes no body.

### Response · 200 OK

- `data` · array of objects
  - `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).
- `pagination` · object
  - `limit` · integer
  - `nextCursor` · string or null: The `cursor` of the next page; null on the last page. A page that comes back full can carry a cursor even when nothing follows: the next page is then empty, with null here. Keep going until it is null.

Related: [Create or rename a workspace](https://docs.gorunner.io/embed/api/workspaces/put-workspace) · [Accounts and people](https://docs.gorunner.io/embed/accounts-and-people)

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