Create workspace code

POST

/workspace-codes

WorkspaceCodes

Creates a new workspace code for the current workspace. Optionally provide a custom code string; auto-generated if omitted.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Workspace code created successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/workspace-codes' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "string",
    "role": "owner",
    "redeemContext": "ANY",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "policy": "LIMITED",
    "maxUses": 1,
    "expiresInDays": 1,
    "expiresAt": "2019-08-24T14:15:22.123Z"
}'

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-04-02 15:44:25

List workspace codes

Get workspace code by ID