Skip to main content

​
Account

All endpoints take X-API-Key: YOUR_API_KEY.

​
Profile and security

  • GET /account/profile / PUT /account/profile (name).
  • PUT /account/password (current_password, new_password of at least 12 characters).
  • PUT /account/otp-login (enabled) toggles code-based sign-in.
  • PUT /account/security-preferences tunes session and sign-in notices.
  • Two-factor: POST /account/2fa/setup returns the provisioning URI, POST /account/2fa/verify confirms with a code, POST /account/2fa/disable turns it off.
  • DELETE /account deletes the account, and additionally requires a login session alongside the key.

​
Notifications

GET /notifications (with page/limit), GET /notifications/unread-count, PUT /notifications/{id}/read, PUT /notifications/read-all, DELETE /notifications/{id}. Preferences live at GET/PUT /notifications/preferences (billingNotifications, usageLimitNotifications, frequency).

​
Usage

GET /dashboard/overview summarizes quotas and activity; GET /account/activity lists events; GET /account/onboarding-profile and GET /onboarding report setup progress.