List the shared plan's workspaces

List the shared plan's workspaces

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

GET /organizations/{id}/shared-plan/workspaces
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'
Response · 200
{
  "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
    }
  ]
}

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.

Parameters1 field
FieldTypeDescription
idrequiredstring · pathThe organization's id (`org_…`), from `GET /whoami` or Organization → API.
Response · 200 fields7 fields
FieldTypeDescription
objectrequiredenumshared_plan_workspace—
workspace_idrequiredstring`ws_…`
external_idrequiredstringYour own id for it, if you gave one.
namerequiredstring—
cap_centsrequiredintegerWhat it may draw from the shared plan each period, allowance and overage together. Null: no cap.
joined_atrequiredstring—
used_centsrequiredintegerWhat it drew this period, counted against its cap.
200401403404429

Search docs and guides

Search the docs and product guides.