Organizations
A workspace with organization-wide language, currency, and document defaults.
- API name:
organizations - Domain: Tenant
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | name | Text | Yes | The name of the organization |
| Organization slug | slug | Text | Yes | A unique identifier for the organization (used in the URL). Use lowercase letters (a-z), numbers (0-9), and dashes (-) only. |
| Timezone | timezone | Constant | Yes | Timezone of the primary corporate office. Anchors organization-wide daily jobs (e.g. end-of-day inventory snapshots at local midnight). |
| Reference currency | currencyReference | Constant | Yes | Default currency for reporting, catalog pricing, and cross-company aggregates. Not the accounting currency of the companies. |
| Content languages | locales | Locale | Yes | |
| Primary language | primaryLocale | Locale | Yes | Language every required catalog text must be written in. The other content languages are optional. |
| Date format | maskDateFormat | Constant | Yes | Default date format for people who choose the organization value in preferences. |
| Time format | maskTimeFormat | Constant | Yes | Default clock format for people who choose the organization value in preferences. |
| Decimals | viewDecimalPlaces | Whole Number | Yes | Default decimal places for screens. A view variable may override this on screen only. Payments, bank files, and fiscal boundaries do not read this value. |
| Screen unit | viewUnitMode | Constant | Yes | Default display unit for views when the view variable is unset. |
| Text transformation | ruleTextCase | Constant | Yes | Fixed option from the allowed set for this field. |
| UI primary color | uiColorPrimary | Color | Yes | |
| UI secondary color | uiColorSecondary | Color | Yes | |
| Appearance | uiColorMode | Constant | Yes | Default light or dark mode for people who choose the organization value in preferences. |
| Metadata | metadata | Text | ||
| Logo | logo | Image | The full logo of the organization, usually including the symbol and name, used for branding across various interfaces. | |
| Symbol | symbol | Image | A short visual identifier or monogram that represents the organization, typically used in compact layouts or icons. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Actions
What you can do with a record. Every action also sends the webhook event organizations.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new organization. | App · WebMCP · API · CLI |
| Edit | update | Save changes to this organization. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this organization and the data that belongs with it. This cannot be undone. | App · WebMCP · API · CLI |