Department
/api/v1/platform/departmentsA unit in the org structure. Self-referential.
listgetcreateupdateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App 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-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name | string | Full name of the department. |
| code | string | Short uppercase code uniquely identifying this department within the tenant. |
| description | string | Optional description of the department's purpose and responsibilities. |
| head_id | uuid | UUID of the Person who leads this department. |
| parent_department_id | uuid | UUID of the parent Department for hierarchical org charts. Null for top-level departments. |
| cost_center_id | uuid | UUID of the CostCenter to which this department's budget is attributed. |
| location_id | uuid | UUID of the primary Location where this department is based. |
| headcount | number | Computed count of active Persons assigned to this department. Read-only — derived by the platform. |
| status | string | Operational status of the department. |
API
Loading manifest…