HRRequest
/api/v1/operations/hr-requestsA request for an HR document or service deliverable.
listgetcreateupdatedeletefulfillSchema
| 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. |
| requester_id* | string | User ID of the person requesting the document/service. |
| type* | enum | employment_letter | certificate | verification | document | otherType of HR request. |
| status | enum | pending | in_progress | completed | rejectedRequest lifecycle status. |
| description* | string | Description of the request. |
| deliverable_type | enum | digital | physicalHow the deliverable will be provided. |
| deliverable_url | string | URL to the generated deliverable. |
| fulfilled_by | string | User ID of the HR person who fulfilled the request. |
| fulfilled_at | date-time | ISO 8601 timestamp when fulfilled. |
| tags | json | Free-form tags. |
API
Loading manifest…