Skip to content

API keys ​

API keys are used by customer systems against the public API. They are managed by a TenantAdmin and currently exist only in the API — there is no screen for this in the field app.

MethodPathRolesDescription
GET/api/api-keysTenantAdminLists the tenant's API keys (revoked ones included), newest first. Never shows the key itself.
POST/api/api-keysTenantAdminCreates an API key. The full key is shown exactly once in the response and cannot be retrieved again.
DELETE/api/api-keys/{id}TenantAdminRevokes an API key. It stops working immediately. Safe to repeat.

The full key is shown only once, when it is created. Store it immediately; a lost key must be revoked and replaced.