API keys
The Pliic REST API is authenticated with secret keys (sk_live_…), one per app. Each key carries a set of scopes that limit what it can access.
The API is available on the Starter and Pro plans. The Free plan does not include this feature.
Where to manage
Section titled “Where to manage”Go to Settings → API keys. The page lists each app in your team with its secret key, the current scopes, last usage, and status (active or revoked).
Only members with the Admin or Owner role can view and manage API keys.
Scopes
Section titled “Scopes”Scopes define which parts of the API the key can use:
| Scope | Allows |
|---|---|
suggestions:read | Read suggestions |
suggestions:write | Create and update suggestions |
tickets:read | Read support tickets |
tickets:write | Create and update tickets |
analytics:read | Read analytics data |
privacy:read | Export user privacy data |
privacy:write | Delete user privacy data |
Select Full access to grant every current and future scope.
Rotating a key
Section titled “Rotating a key”Under Key actions → Rotate key, a new secret key is generated and shown only once. Scopes are preserved, but the old key stops working immediately. Update your integrations with the new value before dismissing the notice.
Revoke and restore
Section titled “Revoke and restore”Revoke disables the key immediately — every request then returns 401. Use Restore to re-enable it. The secret key itself does not change when revoking or restoring.
API reference
Section titled “API reference”The API reference button opens the interactive documentation (OpenAPI) with every endpoint, parameter, and example. The specification is also publicly available at /api/v1/openapi.json.