BigMindBigMindBigMind
Partner APIBETA
Sign inGet an API key
Partner APIBETA
OverviewAuthenticationCustomersPlansAccount & UsageDICOM ReportsWebhooksError codesChangelog

Partner API

BETA

Provision and manage BigMind customers from your own systems — CRM, billing portal, or white-label dashboard.

Quick start

  1. Generate an API key in Settings → API. The full secret is shown once; save it somewhere safe.
  2. Authenticate every request with Authorization: Bearer sk_live_…
  3. Call the API. Try listing your account info:
curl -H "Authorization: Bearer sk_live_..." \
  https://app.bigmind.com/api/partner/v1/account

What you can do

  • Customers — create, list, view, update plan/seats/add-ons, suspend, reactivate, delete (with prorated refund).
  • Plans — read your enabled plans with retail + wholesale pricing.
  • Usage — per-customer storage / device counts; partner-wide rollups for chargeback.
  • Webhooks — subscribe to customer / subscription / credit events.

File-level operations (upload / download / backup) are not part of the public API. Those run agent-side.

Beta status

The API is in Beta. We may make backwards-incompatible changes during Beta; breaking changes will be announced in the changelog. The path /api/partner/v1/* is stable for the duration of v1.

Next

  • Authentication →
  • Customers reference →
  • Error codes →