Remotehost Docs
API ReferenceOrg workspaces

Create a workspace

POST
/orgs/{orgId}/workspaces

Needs workspaces.manage (owners and admins). The kind is set here and never changes. Without a slug, one is made from the name. Audited. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone. API keys cannot call it yet.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

In: header

Path Parameters

orgId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/orgs/string/workspaces" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "kind": "internal"  }'
{  "workspace": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",    "kind": "internal",    "name": "string",    "slug": "string",    "is_default": true,    "manager_workspace_id": "c377aa76-177f-44e7-9bec-93e6b22d7083",    "add_ons": {      "issues": true,      "repos": true,      "agents": true    },    "created_at": "string",    "updated_at": "string"  }}

List an organization's workspaces GET

With `workspaces.read` (owner, admin, security_admin, billing_admin), every workspace in the org. Otherwise (a member), only the workspaces holding a project the caller holds a project role on; never a 403 for a member. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone. API keys cannot call it yet.

Get a workspace GET

With `workspaces.read`, or a role on a project in the workspace. A workspace the caller cannot see answers the same 404 as one that does not exist. An API key pinned to a workspace may read that workspace and no other (another workspace answers the same 404 as one that does not exist): its scopes must carry `project.read`, and the person or service account it acts as must still read every project in the org or hold a project role in that workspace. No other API key can call it. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.