PHphorest
Time Off Policy

List time off policies

Changed on

Get a paginated list of the business's time off policies, ordered alphabetically by name. Time off policies are the types of time off (e.g. Holidays, Sick Leave, Parental Leave) that staff time off is rostered against. Rostered time off references a policy through timeOffPolicyId on staff work time table slots. Set fetch_archived=true when resolving policies for historical time off, as it may reference policies that have since been archived.

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

Request

Path parameters

businessIdstring required

Business id

Query parameters

fetch_archivedboolean

Include archived time off policies

number of records to return, max is 200

page number, default is 0

Response

Time off policies listed

Example response

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

Changes