HIhibob
Time off policies

Get Policy type details

Get details about a given policy type.<br /> <br /> Permissions required: Please refer to the main <a href="https://apidocs.hibob.com/reference/time-off#required-permissions">Time off API Required Permissions</a> page.<br /><br />

get/timeoff/policy-types/{policyType}

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/timeoff/policy-types/{policyType}
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

policyTypestring required

Policy Type name

Response

Policy type details

namestring
activity'paidTimeoff' | 'unpaidTimeoff' | 'workTime'

Defines whether an employee that requests time off would have the leave defined as: <ul> <li>paidTimeoff (Not working, paid): typically for paid vacation, paid sick, and parental leave. </li> <li> unpaidTimeoff (Not working, unpaid): typically for when an employees has used all of their paid time off balance, but still needs to take time off. </li> <li> workTime (Working): typically for working from home (WFH) or business travel. </ul> To learn more, see <a href="https://help.hibob.com/hc/en-us/articles/4409792233489#h_01HSGVRA7M4GTRYEFBYDN1K8E7">Time off policy type settings</a>. </li>

unit'days' | 'hours'

Changes

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