Playground

Playground

Account

/api/v1/crm/accounts

A customer organization.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
owner_idstringAccount owner / account executive. Format: usr-<uuid>.
namestringCompany or customer display name.
legal_namestringFull registered legal name of the company.
industrystringNAICS code or free-text industry classification.
sub_industrystringSecondary industry classification within the primary industry.
websitestringPrimary public website URL.
domainstringEmail domain used for auto-associating contacts to this account.
phonestringMain company phone number.
addressesjsonPhysical addresses associated with the account (billing, shipping, office).
annual_revenuenumberEstimated annual revenue in USD.
employee_countnumberApproximate number of employees.
lifecycle_stagestringCurrent stage of the customer relationship lifecycle.
lead_sourcestringHow this account was first acquired (e.g. inbound, event, referral, outbound, rfp).
health_scorestringCustomer health indicator set by customer success.
parent_account_idstringID of the holding/parent account for subsidiary hierarchy. Format: acc-<uuid>.
descriptionstringFree-text notes about this account.
last_activity_atdate-timeTimestamp of the most recent logged activity against this account.
first_contacted_atdate-timeTimestamp when this account was first contacted.
custom_fieldsjsonPer-tenant schema extension for additional fields.
tagsjsonFree-form string tags for filtering and grouping.
versionnumberOptimistic-concurrency version counter.

API

client.customer.accounts.*
Loading manifest…