Delete an API key
Revokes an API key so it stops authenticating requests. Requires a user access token. Admins can delete any key, and members only their own personal keys.
Authorization
bearer User access token authentication. Every endpoint accepts it, and endpoints that act as a person accept only it. Send a WorkOS access token in the Authorization header as: Bearer <token>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
The unique ID of the API key.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
The API version for this request. Send 2026-11 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Response Body
curl -X DELETE "https://example.com/workspaces/string/api-keys/string" \ -H "clarify-version: 2026-11"Create an API key
Creates an API key and returns it as a JSON:API resource whose `cleartext_api_key` holds the secret, shown only this once. Requires a user access token, because an API key cannot create another API key. Only admins can create `workspace` keys.
List API keys
Returns API keys as a JSON:API list with `links` and `meta`, in one page. Requires a user access token. Admins see every personal and workspace key, and members see only their own personal keys. Secrets are never returned.