Get a workspace
GET/api/v1/organizations/{id}/workspaces/{workspace_id}
GET /organizations/{id}/workspaces/{workspace_id}
# API: no generated example for GET https://www.unitpost.com/api/v1/organizations/:id/workspaces/:workspace_idResponse · 200
{
"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"
}One of the organization's workspaces. Takes an organization key (ok_live_…) with organizations:read.
Parameters2 fields
| Field | Type | Description |
|---|---|---|
idrequired | string · path | The organization's id (`org_…`), from `GET /whoami` or Organization → API. |
workspace_idrequired | string · path | The workspace's id (`ws_…`). |
Response · 200 fields12 fields
| Field | Type | Description |
|---|---|---|
objectrequired | enumworkspace | — |
idrequired | string | `ws_…` |
namerequired | string | — |
slugrequired | string | — |
external_idrequired | string | Your own id for it, unique in the organization. |
planrequired | string | `free`, or the paid plan's key. |
paid_byrequired | enumworkspace | organization | — |
requires_paid_planrequired | boolean | No free allowance: the Owner already has a free workspace, so it sends once a plan is bought. |
closed_atrequired | string | — |
restorable_untilrequired | string | — |
created_atrequired | string | — |
hosted_invoice_url | string | On create only: the card asked for authentication; paying here starts the plan. |
200401403404429