timeOff

List policies

Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, balances and required attachments or custom fields. Use this before creating a time-off request so you know upfront whether the request needs custom field values.

Token scopes: time-off:read

get/time_offs/profile/{hris_profile_id}/policies

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/time_offs/profile/{hris_profile_id}/policies
  • Auth: HTTP bearer

Path parameters

hris_profile_idstring uuid required

hrisProfileId id.

Query parameters

policy_type_name'Adoption leave' | 'Advanced vacation' | 'Bereaved partner's paternity leave' | 'Bereavement leave' | 'Blood donation leave' | 'Breastfeeding leave' | 'Carer's leave' | 'Childbirth leave' | 'Childcare leave' | 'Civic/public duty leave' | 'Compensatory leave' | 'Disability leave' | 'Doctor's appointment leave' | 'Family & domestic violence leave' | 'Family responsibility leave' | 'Floating Holiday Allowance' | 'Hajj leave' | 'Hospitalization leave' | 'Long Service Leave' | 'Marriage/wedding leave' | 'Maternity leave' | 'Menstrual leave' | 'Military leave' | 'Moving leave' | 'Neonatal care leave' | 'Other leave' | 'Paid leave' | 'Parental bereavement leave' | 'Parental leave' | 'Paternity leave' | 'Personal leave' | 'Pregnancy leave' | 'Regional holiday' | 'RTT' | 'Shared parental leave' | 'Sick leave' | 'Study leave' | 'Supplementary Leave' | 'Unpaid leave' | 'Vacation' | 'Vacation - public holidays replacement' | 'Volunteer leave' | 'Work accident leave' | 'Work Location'

Policy type name.

policy_type_idstring uuid

policy type id

Response

Successful operation.

Changes

No recorded changes to this operation across all 1 revision of this API.