OnboardingTask
/api/v1/hr/onboarding-tasksA task in a new hire's onboarding sequence.
listgetcreateupdatecompleteSchema
| 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. |
| person_id | uuid | UUID of the Person (new hire) this onboarding task belongs to. |
| title | string | Short, action-oriented title for the task. |
| description | string | Detailed instructions or context for completing this task. |
| category | string | Functional category grouping tasks of a similar nature together in the onboarding checklist. |
| assigned_to_id | uuid | UUID of the Person responsible for completing or facilitating this task. May be the new hire themselves, their manager, or an IT/HR team member. |
| due_date | date-time | ISO 8601 date by which this task should be completed. |
| completed_at | date-time | ISO 8601 timestamp when this task was marked completed. Null while still pending or in progress. |
| status | string | Current execution state of this task. |
| order | number | Zero-based display order within the onboarding checklist. Lower values appear first. |
| template_id | uuid | UUID of the onboarding template from which this task was generated. Null for ad-hoc tasks created directly. |
API
client.hr.onboardingTasks.*Loading manifest…