Get User Workspaces
GET
/web/v1/system/workspaces/mine JWTRetrieves all workspaces the authenticated user is a member of.
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
No query or path parameters required.
Success Response
Status: 200 OK
Returns an array of workspace objects the authenticated user is a member of.
Success 200
{
"version": "1.3.0",
"timestamp": 1709337600000,
"success": true,
"code": "2000",
"message": "SUCCESS",
"data": [
{
"bizId": "WS_INVITE_TEST_001",
"institutionBizId": "INST_001",
"entityBizId": null,
"workspaceName": "Primary 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"
},
{
"bizId": "WS_INVITE_TEST_002",
"institutionBizId": "INST_001",
"entityBizId": null,
"workspaceName": "Secondary Workspace",
"workspaceTimezone": "America/New_York",
"workspaceStatus": {
"value": 10010701,
"name": "ACTIVE",
"code": "ACTIVE"
},
"workspaceKind": {
"value": 10010801,
"name": "LIVE",
"code": "LIVE"
},
"extraData": null,
"createdAt": "2026-03-22T11:00:00Z",
"updatedAt": "2026-03-22T11:00:00Z"
}
]
}Response Item 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
- This endpoint operates on the authenticated user's own resources.
- Returns an empty array
[]if the user has no workspace memberships. - Includes workspaces where the user is owner or a regular member.