Playground

Playground

Capacity

/api/v1/work/capacity

A Person's available capacity for a period.

listgetset

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp 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-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
person_iduuidUUID of the Person whose capacity is being allocated.
project_iduuidUUID of the project this capacity allocation is assigned to.
period_startdate-timeFirst day of the allocation period (ISO 8601 date, inclusive).
period_enddate-timeLast day of the allocation period (ISO 8601 date, inclusive).
allocated_pctnumberPercentage of the person's working time allocated to this project during the period (0–100).
confirmed_by_iduuidUUID of the Person (typically a resource manager) who confirmed this allocation. Null while unconfirmed.
confirmed_atdate-timeISO 8601 timestamp when this allocation was confirmed. Null if not yet confirmed.
notesstringOptional free-text notes about this allocation (e.g., scope or constraints).

API

client.work.capacity.*
Loading manifest…