Playground

Playground

LeaveRequest

/api/v1/employee/leave-requests

Time-off request awaiting approval.

listgetcreateapprovereject

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 submitting this leave request.
typestringLeave category. 'annual' = planned vacation, 'sick' = illness absence, 'parental' = maternity/paternity/adoption leave, 'public_holiday' = bank or public holida
start_datedate-timeISO 8601 date when the leave period begins (inclusive).
end_datedate-timeISO 8601 date when the leave period ends (inclusive).
statusstringCurrent approval workflow status of the leave request.
approved_by_iduuidUUID of the Person who approved or rejected this request.
approved_atdate-timeISO 8601 timestamp when the approval decision was made.
notesstringFree-text notes from either the requester or the approver.

API

client.employee.leaveRequests.*
Loading manifest…