CHcheckhq

Get a time off policy assignment

Changed on

Returns the specified time off policy assignment, including the employee's live balance.

get/time-off/assignments/{assignment}

Request

Path parameters

assignmentstring required

ID of the assignment.

Response

200

idstring

Unique identifier for the assignment.

policystring

ID of the assigned policy.

policy_namestring

Name of the assigned policy.

employeestring

ID of the employee the policy is assigned to.

activeboolean

Whether the assignment is active. Assignments are active when created.

effective_startstring date

The date the assignment takes effect. Waiting periods are counted from this date, and for policies with a policy_year.basis of assignment, the policy year resets on its anniversary. Defaults to the employee's start date. Can't be changed after the assignment is created.

balancestring decimal

The employee's live balance on the policy, in hours. This is the sum of all time off entries on the assignment.

Example response

{
  "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