Get User Workspaces

GET/web/v1/system/workspaces/mine JWT

Required Gateway Headers

All API requests require gateway headers. See Required Headers for the complete list. In local/test environments, you must also include Cloudflare simulation headers (CF-Connecting-IP, Cf-Ray, cf-ipcountry).

Retrieves all workspaces the authenticated user is a member of, including their role, ownership status, and workspace accessibility information.

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": "2.0.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": [
    {
      "userBizId": "ACC_SYS_001",
      "workspaceBizId": "WS_INVITE_TEST_001",
      "workspaceName": "Primary Workspace",
      "workspaceKind": {
        "code": "LIVE",
        "value": 10010801,
        "label": "Live",
        "description": "Production workspace"
      },
      "institutionBizId": "INST_001",
      "workspaceRoleBizId": "ROLE_OWNER_001",
      "workspaceRoleName": "Owner",
      "joinSource": {
        "code": "CREATED",
        "value": 10040101,
        "label": "Created",
        "description": "Created the workspace"
      },
      "isOwner": true,
      "isDefault": true,
      "enterable": true,
      "defaultEligible": true,
      "policyConfig": null,
      "createdAt": "2026-03-22T10:30:00Z",
      "updatedAt": "2026-03-22T10:30:00Z"
    },
    {
      "userBizId": "ACC_SYS_001",
      "workspaceBizId": "WS_INVITE_TEST_002",
      "workspaceName": "Secondary Workspace",
      "workspaceKind": {
        "code": "SANDBOX",
        "value": 10010802,
        "label": "Sandbox",
        "description": "Testing workspace"
      },
      "institutionBizId": "INST_001",
      "workspaceRoleBizId": "ROLE_MEMBER_001",
      "workspaceRoleName": "Member",
      "joinSource": {
        "code": "INVITED",
        "value": 10040102,
        "label": "Invited",
        "description": "Joined via invitation"
      },
      "isOwner": false,
      "isDefault": false,
      "enterable": true,
      "defaultEligible": true,
      "policyConfig": null,
      "createdAt": "2026-03-22T11:00:00Z",
      "updatedAt": "2026-03-22T11:00:00Z"
    }
  ]
}

Response Item Fields

Field	Type	Description
userBizId	string	Authenticated user's account business ID
workspaceBizId	string	Unique workspace business ID
workspaceName	string	Workspace display name
workspaceKind	object	Workspace kind enum — {code, value, label, description} (e.g. LIVE, SANDBOX)
institutionBizId	string	Parent institution business ID
workspaceRoleBizId	string	Business ID of the user's role in this workspace
workspaceRoleName	string	Display name of the user's role (e.g. "Owner", "Member")
joinSource	object	How the user joined — enum {code, value, label, description} (e.g. CREATED, INVITED)
isOwner	boolean	Whether the user is the workspace owner
isDefault	boolean	Whether this is the user's default workspace
enterable	boolean	Whether the user can currently enter/access this workspace
defaultEligible	boolean	Whether this workspace is eligible to be set as the user's default
policyConfig	object or null	Workspace-level policy configuration, null if not set
createdAt	string (ISO 8601)	When the user's membership was created
updatedAt	string (ISO 8601)	When the user's membership was last updated

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.
• enterable may be false if the workspace is suspended or the user's membership is inactive.
• defaultEligible indicates whether the workspace can be selected as the user's default via Set Default Workspace.
• workspaceKind and joinSource follow the standard enum format with code, value, label, and description fields.