Get Workspace

Developing

Develop Env

http://localhost:3000/api

GET

GET /workspaces/{workspace_id}

workspace

Maintainer:Suhaib Ghattass

Purpose
Retrieve full details of a specific workspace, including settings, members, and enabled features. Used when loading a workspace dashboard or configuring integrations.

Auth / Scope
User must be a member of the workspace (via workspace_members) or have org-level workspace:read permission.

Headers
Authorization: Bearer <USER_JWT>
Accept-Language: en-US (optional, for localized settings)
Idempotency & retries
Not applicable (safe GET).

Rate limits
100 requests/minute per user.

Request

Path Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3000/apiGET /workspaces/'

Response Example

{
    "message": "Workspace retrieved successfully",
    "data": {
        "workspaceId": "w-7d8e9f0a-1b2c-3d4e-5f6g-7h8i9j0k1l2m",
        "orgId": "a1b2c3d4-5678-90ef-1234-567890abcdef",
        "name": "CS101: Introduction to AI",
        "description": "Fall 2025 lecture series",
        "visibility": "org",
        "createdBy": "u-9f8e7d6c-5b4a-3210-fedc-ba9876543210",
        "createdAt": "2025-10-22T15:45:30Z",
        "updatedAt": "2025-10-22T16:00:00Z",
        "settings": {
            "timezone": "America/Los_Angeles",
            "educationMode": true,
            "lmsIntegration": "canvas"
        },
        "allowedDomains": [
            "university.edu"
        ],
        "featureFlags": {
            "examGeneration": true,
            "aiAttendee": false
        },
        "supportedLanguages": [
            "en-US",
            "es-ES"
        ],
        "memberCount": 12,
        "meetingCount": 8,
        "subscriptionId": "sub-abc123def456"
    }
}

Modified at 2025-10-22 21:43:00

Create Workspace

Update Workspace