Deel: Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment window
Retrieve Benefits for Employee: 200 response body, field data / item / benefits / item / enrollment_window. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment window
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration). |
ends_at | string | Required within parent | Last date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). After this date, enrollment is locked until a new window is triggered. |
starts_at | string | Required within parent | First date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). Enrollment actions are accepted on or after this date only. |
trigger | JSON | Required within parent | |
trigger (anyOf 1) | string | Alternative | Business reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions. |
trigger (anyOf 2) | null | Alternative | Business reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions. |