HIhibob
Time off policies

Get Policy details.

Get details about a given policy.<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.

get/timeoff/policies

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/timeoff/policies
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

policyNamestring required

Policy name.

Response

Policy

namestring
allowancenumber

Base annual allowance.

maxBalancenumber

Maximum balance at the end of the cycle.

minBalancenumber

Minimum balance cap.

minTimeOffRequestDuration'fullDay' | 'halfDay' | 'fullHour' | 'halfHour' | 'quarterHour' | 'tenMinutes'

The shortest amount of time employees can request.

bookingWorkDaysOnlyboolean

This property defines whether non-working days such as weekends and bank holidays will be deducted from the balance. <br /><br /> Change in behavior starting November 20, 2024: From this date, the bookingWorkDaysOnly setting has moved from the Policy Type to the Policy details. Policies that were created before this date will return the original value from the policy type.

approvalRequiredboolean

Requests require approval.

descriptionstring

Policy description.

unit'days' | 'hours'

Changes

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