API keys

Settings → API holds the API Keys card. You need apikeys:write to create keys.

Create a key

Click Create Key

Give it a Key name that says where it is used, for example checkout-service.

Pick scopes

Scope	Allows
Create cases (`cases:write`)	`POST /cases`, and information requests through the API
Read cases (`cases:read`)	`GET /cases/{caseId}`, `GET /cases`
Deliver callbacks (`cases:callback`)	Post an external callback to a paused node
Set entity attributes (`attributes:write`)	`POST /customer-attributes`
Read tags (`tags:read`)	List a case’s tags
Manage tags (`tags:write`)	Add or remove a case’s tags, restricted to the managed vocabulary

A request without a matching scope is rejected with 403.

Copy it once

API Key Created shows the value a single time. Store it in your secret manager before clicking Done.

Send the key on every request as X-API-Key. See Use the Case API.

The bin icon asks Delete API Key. The key stops working immediately and every integration using it breaks.

Keys cannot be rotated or renamed from the console. To rotate, create a new key, switch your systems, then delete the old one.