CHcheckhq

List time off policies

Changed on

Returns a list of time off policies.

get/time-off/policies

Request

Query parameters

companystring

Filter to policies belonging to the specified company.

earning_typestring

Filter to policies with the specified earning type. One of pto or sick.

activeboolean

Filter to active or inactive policies.

limitinteger

Number of results returned per page. The maximum value is 25.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

nextstring nullable
previousstring nullable

Example response

{
  "results": [
    {
      "id": "top_4fKq8Wz1mN2pR7sT",
      "company": "com_sx3svU6K8c5ZkSFlOh5p",
      "name": "California Paid Sick Leave",
      "active": true,
      "policy_year": {
        "basis": "fixed_date",
        "date": "01-01"
      },
      "earning_type": "sick",
      "accrual_method": "per_hour_worked",
      "annual_grant": {
        "hours": "40.00",
        "partial_year_method": "prorate"
      },
      "per_payroll": {
        "hours_per_year": "120.00"
      },
      "per_hour_worked": {
        "hours": "1.00",
        "per_hours_worked": "30.00"
      },
      "limits": {
        "min_balance": "0.00",
        "max_rollover": "40.00",
        "max_accrual_per_policy_year": "40.00"
      },
      "usage_waiting_period_days": 90
    }
  ]
}

Changes