Sites
Physical premises of one company, such as a plant, warehouse, or store.
- API name:
sites - Domain: Structure
- Modules: Master data, Directory, 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 | |
| Position | rank | Order rank | Yes | |
| Name | label | Text I18n | ||
| Manager | userId | User | Default contact or manager for the site. | |
| Address | address | Address | Physical address of the site. A complete address is required to publish and cannot change after publish. | |
| Capabilities | functions | Constant | Yes | Fixed option from the allowed set for this field. |
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Links | links | Link | Links | ||
| Time zone | timezone | Constant | Yes | Local time zone of the site. It cannot change after publish. |
| Price basis | priceBasis | Constant | Whether unit prices include tax (gross) or exclude tax (net). | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
Actions
What you can do with a record. Every action also sends the webhook event sites.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new site. | App · API · MCP · CLI |
| Edit | update | Save changes to this site. | App · API · MCP · CLI |
| Disable | disable | Turn this site off for new use. Existing references stay. Enable it again to use it. | App · API · MCP · CLI |
| Enable | undisable | Turn this site back on for new use. | App · API · MCP · CLI |
| Publish | publish | Make this site available for use. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this site. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this site again. | App · API · MCP · CLI |
| Archive | archive | Retire this site from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this site to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this site and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.