Canonical schema
The shape every adapter writes to. Designed for the SMB operations long tail — work, money, conversations, identity. Field-level edit history is built in: every value records which adapter set it, when, and what the previous value was.
This is a high-level overview. The full machine-readable schema is exposed through /api/v1/schema and the OpenAPI contract at /api/v1/openapi.json.
Identity
Party
Any person or organization a business interacts with — customer, lead, vendor, employee, partner. Single record across every connected tool.
partyTypedisplayNamefirstNamelastNameorgNamelifecycleStageLocation
A physical place attached to a Party — service address, billing address, job site, branch office.
addressLine1cityregionpostalCodecountrygeoContactMethod
A way to reach a Party — phone, email, messaging handle. Normalized for matching across adapters.
channelvaluenormalizedValueisPrimaryWork
WorkRecord
The unit of work a business does — job, ticket, matter, case, appointment, task. Polymorphic, vertical-shaped.
workTypetitlestatusscheduledAtcompletedAtassignedTorecordStateMoney
MoneyRecord
Anything money-shaped — invoice, estimate, payment, refund, statement. Reconciles to QBO / Xero / Stripe.
recordTypeamountCentscurrencyissuedAtdueAtpaidAtstatusComms
Conversation
Any thread — call, SMS, email, chat. Carries transcripts, summaries, and links to the Party + WorkRecord.
channeldirectionstartedAtendedAttranscriptsummaryTry it in the portal
- Grab the live OpenAPI 3.1 spec at /api/v1/openapi.json.
- Approved partners can mint a sandbox key in /portal/api-keys and hit any entity endpoint right away.
- Sample payloads per entity ship in the quickstart.
- Migration guides for schema versions land here as we cut new majors.