Skip to main content
Your integration talks to a customer’s workspace through the normal workspace APIs (Messaging, Publishing, Link in Bio and webhooks), with a workspace API key. You can issue that key yourself for any workspace you provisioned.
201
plain_text_token is returned once. It is stored as a hash and cannot be shown again. Put it straight into your secret store, and keep the response body out of your logs (it is sent with Cache-Control: no-store).

Rules

  • Same permissions as the dashboard. scopes takes the same list a workspace admin sees. A permission the workspace cannot have, for a feature its plan does not include, is a 422, never silently dropped.
  • 25 live keys per workspace, shared with keys made in the dashboard. Revoke an unused one before creating another.
  • The key acts as the customer’s admin. It is attributed to the workspace admin you provisioned, and stops working if that person stops being an admin.
  • Audited. Every key you issue is written to the customer’s audit log, naming your partner account.

List and revoke

  • GET /api/partner/workspaces/{workspace}/api-keys lists the workspace’s keys: name, prefix, scopes, dates and last use per API. Never the secret.
  • DELETE /api/partner/workspaces/{workspace}/api-keys/{id} revokes a key immediately, for every API. Repeating it returns 200, so retries are safe.
A workspace that is not yours, or does not exist, is a 404.