PHphorest
Time Off Policy

Get a time off policy

Changed on

Get a single time off policy by id. Archived policies are returned too.

get/api/business/{businessId}/time-off-policy/{timeOffPolicyId}

Request

Path parameters

businessIdstring required

Business id

timeOffPolicyIdstring required

Time off policy id

Response

Time off policy found

timeOffPolicyIdstring

Time off policy ID

namestring

Name of the time off policy as shown in Phorest

descriptionstring

Optional description of the time off policy

policyType'PAID_LEAVE' | 'SICK_LEAVE' | 'UNPAID_LEAVE'

Category of the time off policy

paidboolean

Whether time off under this policy is paid. PAID_LEAVE and SICK_LEAVE are paid, UNPAID_LEAVE is not

archivedboolean

Whether the time off policy has been archived. Archived policies can still be referenced by previously rostered time off

Example response

{
  "timeOffPolicyId": "eTC3QY5W3p_HmGHezKfxJw",
  "name": "Parental Leave",
  "description": "Statutory parental leave",
  "policyType": "PAID_LEAVE",
  "paid": true
}

Changes