Get Workspace (v1)

Method + Path

GET /v1/workspace/:workspaceId

Actual backend path: /v1/workspace/:workspaceId

Description

Get workspace details and settings.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• workspace.view or workspace.update

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Response (200)

{
  "workspace": {
    "id": "507f1f77bcf86cd799439011",
    "name": "My Workspace",
    "slogan": "Workspace slogan",
    "email": "workspace@example.com",
    "logos": {
      "primary": "https://example.com/logo-primary.jpg",
      "secondary": "https://example.com/logo-secondary.jpg"
    },
    "workingHours": {
      "days": [
        {
          "day": 0,
          "isOpen": false
        },
        {
          "day": 1,
          "isOpen": true,
          "startTime": "09:00",
          "endTime": "17:00"
        }
      ],
      "timezone": "America/New_York"
    },
    "createdAt": "2024-01-15T10:00:00Z"
  }
}

Common Errors

• 401 Unauthorized: Missing or invalid authentication token
• 403 Forbidden: Insufficient permissions
• 404 Not Found: Workspace not found
• 500 Internal Server Error: Server error