---
title: "List the shared plan's workspaces"
description: "Every workspace on the shared plan now, oldest first: its id, your external_id, name, its cap (cap_cents: what it may draw each period, allowance and overage together; null for none), joined_at, and what it drew this period (used_cents). `GET /api/v1/organizations/{id}/shared-plan/workspaces`"
url: https://www.unitpost.com/docs/platform/get-organizations-id-shared-plan-workspaces
section: "Platform API reference"
updated: 2026-11-17
---
# List the shared plan's workspaces

`GET /api/v1/organizations/{id}/shared-plan/workspaces`

Every workspace on the shared plan now, oldest first: its id, your `external_id`, `name`, its cap (`cap_cents`: what it may draw each period, allowance and overage together; null for none), `joined_at`, and what it drew this period (`used_cents`). One page: a shared plan covers a bounded number of workspaces, so `has_more` is always false. Takes an organization key (`ok_live_…`) with `organizations:read`.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | The organization's id (`org_…`), from `GET /whoami` or Organization → API. |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | enum | yes | One of: `shared_plan_workspace`. |
| `workspace_id` | string | yes | `ws_…` |
| `external_id` | string | yes | Your own id for it, if you gave one. |
| `name` | string | yes | — |
| `cap_cents` | integer | yes | What it may draw from the shared plan each period, allowance and overage together. Null: no cap. |
| `joined_at` | string | yes | — |
| `used_cents` | integer | yes | What it drew this period, counted against its cap. |

## Responses

| Status | Description |
| --- | --- |
| 200 | The workspaces on the shared plan. |
| 401 | Missing or invalid organization key (a workspace key is refused). |
| 403 | API access not approved for the organization, the key lacks the capability, or no User-Agent. |
| 404 | Not this key's organization, or not one of its workspaces. |
| 429 | The organization's rate limit. |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/organizations/org_123/shared-plan/workspaces' \
  -H 'Authorization: Bearer YOUR_ORG_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "shared_plan_workspace",
      "workspace_id": "workspace_123",
      "external_id": "external_123",
      "name": "Example",
      "cap_cents": 0,
      "joined_at": "2026-01-01T00:00:00.000Z",
      "used_cents": 0
    }
  ]
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/get-organizations-id-shared-plan-workspaces
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json
