Get workspace code by ID

GET

/workspace-codes/{workspaceCodeId}

WorkspaceCodes

Retrieves a specific workspace code by its unique identifier.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Workspace code retrieved successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/workspace-codes/' \
--header 'x-external-user-id;' \
--header 'x-user-id;'

Response Example

{
    "workspaceCodeId": "string",
    "code": "string",
    "workspaceId": "stringstri",
    "accountId": "stringstri",
    "role": "owner",
    "redeemContext": "ANY",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "policy": "LIMITED",
    "maxUses": 1,
    "usageCount": 0,
    "status": "ACTIVE",
    "expiresAt": "2019-08-24T14:15:22.123Z",
    "createdBy": "string",
    "actorType": "user",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-06-15 16:41:21

Create workspace code

Revoke workspace code