Domain Model
Organization
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| legalName | string | Yes | — | Legal name |
| displayName | string | Yes | — | Display name |
| status | enum(active, inactive, archived) | Yes | "active" | Status |
| categories | string[] | No | — | Categories |
| parentOrganizationId | unknown | No | — | ID of the associated parent organization |
| website | string.uri | No | — | Website |
| primaryPhone | string | No | — | Primary phone |
| primaryEmail | string.email | No | — | Primary email |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| notesSummary | string | No | — | Notes summary |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| legalName | string | Yes | — | Legal name |
| displayName | string | Yes | — | Display name |
| status | enum(active, inactive, archived) | Yes | "active" | Status |
| categories | string[] | No | — | Categories |
| parentOrganizationId | unknown | No | — | ID of the associated parent organization |
| website | string.uri | No | — | Website |
| primaryPhone | string | No | — | Primary phone |
| primaryEmail | string.email | No | — | Primary email |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| notesSummary | string | No | — | Notes summary |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| legalName | string | No | — | Legal name |
| displayName | string | No | — | Display name |
| status | enum(active, inactive, archived) | No | — | Status |
| categories | string[] | No | — | Categories |
| parentOrganizationId | unknown | No | — | ID of the associated parent organization |
| website | string.uri | No | — | Website |
| primaryPhone | string | No | — | Primary phone |
| primaryEmail | string.email | No | — | Primary email |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| notesSummary | string | No | — | Notes summary |