Skip to main content
An account is the customer organization the authenticated user is operating as. Every buyer request runs in the context of one account, identified by a numeric id and carrying a role (MEMBER, ADMIN, or SUPER_ADMIN) that gates what the caller can do. A user can belong to several accounts; the account API lets you read the current context, list the accounts you can access, and switch your integration between them. Accounts can form a parent/child hierarchy. An ADMIN can spin up child accounts under a parent (creating the parent on the fly if the customer was standalone), set each customer’s registered customerDomain, and configure membership so that users with a verified matching-domain email auto-join without manual approval. Separately, each user manages their own notification preferences — the set of event types and channels (email, in_app) they opt into.

​
Key concepts

ConceptDescription
Current accountThe customer context the request authenticates as — id, company, name, role, customerDomain
Child accountA customer created under a parent in the hierarchy; only children can be deleted
customerDomainRegistered organization domain; required before domain auto-join can be enabled
MembershipPer-customer access settings, notably allowDomainAutoJoin
Notification preferencesPer-user opt-ins of notificationType × channel
RoleMEMBER, ADMIN, or SUPER_ADMIN; admin-only operations require ADMIN on the target customer

​
Task reference

Get current account

GET /accounts/current — your current context

List customer accounts

GET /accounts — accounts you can access

Create child account

POST /accounts/create-child — add a child customer

Update customer domain

PATCH /accounts/:customerId/domain — set the org domain

Delete child account

DELETE /accounts/:customerId — remove a child customer

Get membership

GET /accounts/:customerId/membership — read access settings

Update membership

PATCH /accounts/:customerId/membership — toggle domain auto-join

Get notification preferences

GET /notification-preferences — your opt-ins

Update notification preferences

PUT /notification-preferences — replace your opt-ins