List the organization's workspaces

List the organization's workspaces

GET/api/v1/organizations/{id}/workspaces

GET /organizations/{id}/workspaces
# API: no generated example for GET https://www.unitpost.com/api/v1/organizations/:id/workspaces
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "workspace",
      "id": "id_123",
      "name": "Example",
      "slug": "string",
      "external_id": "external_123",
      "plan": "string",
      "paid_by": "workspace",
      "requires_paid_plan": false,
      "closed_at": "2026-01-01T00:00:00.000Z",
      "restorable_until": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "hosted_invoice_url": "https://example.com"
    }
  ]
}

The organization's workspaces, newest first and cursor-paginated (limit, after, before). external_id narrows to the workspace you gave that id. Takes an organization key (ok_live_…) with organizations:read.

Parameters5 fields
FieldTypeDescription
idrequiredstring · pathThe organization's id (`org_…`), from `GET /whoami` or Organization → API.
limitinteger · query—
afterstring · query—
beforestring · query—
external_idstring · query—
Response · 200 fields12 fields
FieldTypeDescription
objectrequiredenumworkspace—
idrequiredstring`ws_…`
namerequiredstring—
slugrequiredstring—
external_idrequiredstringYour own id for it, unique in the organization.
planrequiredstring`free`, or the paid plan's key.
paid_byrequiredenumworkspace | organization—
requires_paid_planrequiredbooleanNo free allowance: the Owner already has a free workspace, so it sends once a plan is bought.
closed_atrequiredstring—
restorable_untilrequiredstring—
created_atrequiredstring—
hosted_invoice_urlstringOn create only: the card asked for authentication; paying here starts the plan.
200401403404429

Search docs and guides

Search the docs and product guides.