Create brand api key

Create brand api key

POST /v1/brands/{brand_id}/api-keys

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/api-keys' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "Replacement tent pole set"
}'

201

{
  "token": "YOUR_API_KEY",
  "key": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_global": true,
    "brand_slugs": [
      "acme-outdoors"
    ],
    "label": "Replacement tent pole set",
    "subject": "Replacement tent pole set",
    "token_prefix": "YOUR_API_KEY",
    "created_by": "string",
    "created_at": "2026-08-31T14:22:05Z",
    "last_used_at": "2026-08-31T14:22:05Z",
    "revoked_at": "2026-08-31T14:22:05Z"
  }
}

Path parameters

brand_id · string (uuid) · required

Request body

object

label · string

Defaults to ‘<slug> key’

Response

object

token · string · required

Plaintext sk_live_… token — shown once; only its hash is persisted

key · object · required

API key record (never contains the token)

Show key

id · string (uuid) · required

tenant_id · string (uuid)

is_global · boolean · required

brand_slugs · string[] · required

label · string · required

subject · string · required

token_prefix · string · required

created_by · string

created_at · string (date-time) · required

last_used_at · string (date-time)

revoked_at · string (date-time)

Status codes

Code	Meaning
201	Key created.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/api-keys' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "Replacement tent pole set"
}'

201

{
  "token": "YOUR_API_KEY",
  "key": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_global": true,
    "brand_slugs": [
      "acme-outdoors"
    ],
    "label": "Replacement tent pole set",
    "subject": "Replacement tent pole set",
    "token_prefix": "YOUR_API_KEY",
    "created_by": "string",
    "created_at": "2026-08-31T14:22:05Z",
    "last_used_at": "2026-08-31T14:22:05Z",
    "revoked_at": "2026-08-31T14:22:05Z"
  }
}