POST
/
session
/
switch-workspace
Switch Active Workspace
curl --request POST \
  --url https://{deploymentHost}/session/switch-workspace \
  --header 'Content-Type: application/json' \
  --data '{
  "workspace_id": "workspace_456789123"
}'
{
  "status": 200,
  "message": "",
  "data": {
    "workspace": {
      "id": "workspace_456789123",
      "name": "Marketing Team",
      "slug": "marketing-team"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Body

application/json

Response

200
application/json

Successfully switched workspace

The response is of type object.