Skip to the documentation
API

Choose the workspace the app opens

Switches the workspace the app opens for the person, as the workspace switcher does.

PUT/workspaces/active

Runs the real call on your workspace.

PUT /workspaces/active

Switches the workspace the app opens for the person, as the workspace switcher does.

Example

Needs account:write. workspaceId is any workspace from GET /workspaces, or the personal space. Answers with the workspace the app opens now.

curl
curl -X PUT "$OE/workspaces/active" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "workspaceId": "6d2f8a41-9c3e-4b7a-8e15-2f0c9d4b7a63" }'
Response
{  "object": "workspace",  "id": "6d2f8a41-9c3e-4b7a-8e15-2f0c9d4b7a63",  "name": "Acme Support",  "slug": "acme-support",  "email": null,  "kind": "business",  "isOwner": true,  "createdAt": "2026-10-03T09:12:40.000Z"}

A workspace the person cannot open is a 404.

It changes nothing for the key or the app making the call.

Reference