CHcheckhq

List time off policy assignments

Changed on

Returns a list of time off policy assignments, including each employee's live balance.

get/time-off/assignments

Request

Query parameters

companystring

Filter to assignments for employees of the specified company.

employeestring

Filter to assignments for the specified employee.

policystring

Filter to assignments for the specified policy.

activeboolean

Filter to active or inactive assignments.

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": "toa_3kWm9Qz5Ht2Lp8Nv",
      "policy": "top_4fKq8Wz1mN2pR7sT",
      "policy_name": "California Paid Sick Leave",
      "employee": "emp_sx3svU6K8c5ZkSFlOh5p",
      "active": true,
      "effective_start": "2026-03-12",
      "balance": "17.16"
    }
  ]
}

Changes