Get Workspace

GET/web/v1/workspaces/{workspaceBizId} JWT

Retrieves workspace details by its business ID.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token
X-Workspace-Id		Target workspace ID

Request Parameters

Name	Type	Required	In	Description
workspaceBizId	String	Required	path	Business ID of the workspace

Success Response

Status: 200 OK

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "WS_INVITE_TEST_001",
    "institutionBizId": "INST_INVITE_TEST_001",
    "entityBizId": null,
    "workspaceName": "Test Workspace",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "value": 10010701,
      "name": "ACTIVE",
      "code": "ACTIVE"
    },
    "workspaceKind": {
      "value": 10010801,
      "name": "LIVE",
      "code": "LIVE"
    },
    "extraData": null,
    "createdAt": "2026-03-22T10:30:00Z",
    "updatedAt": "2026-03-22T10:30:00Z"
  }
}

Response Fields

Field	Type	Description
bizId	String	Unique workspace business ID
institutionBizId	String	Parent institution business ID
entityBizId	String	Associated entity business ID (nullable)
workspaceName	String	Workspace display name
workspaceTimezone	String	IANA timezone identifier
workspaceStatus	Object	Status enum with value, name, code
workspaceKind	Object	Workspace kind (LIVE / SANDBOX)
extraData	String	Free-form JSON string (nullable)
createdAt	String	ISO 8601 creation timestamp
updatedAt	String	ISO 8601 last update timestamp

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

• Requires workspace membership.
• Returns the full workspace object including status and kind enums.