API Reference

Time-Offs

Team members can apply for time off while keeping the project team informed to ensure the project's progress remains unaffected. This allows team members the flexibility to take time off without hindering ongoing project activities.

Default fields

FieldDescription
timeOffIdA unique identifier for the time-off, generated by the system. This Id can be used to identify the time off globally.
userThe user who requested the time off.
startDateThe start date of the time off. This field is required and should be in the format YYYY-MM-DD.
endDateThe end date of the time-off. This field is required and cannot be left blank. The end date must be on or after the start date, formatted as YYYY-MM-DD.
typeThe type of time off selected. This field is required and possible values are FULL_DAY, HALF_DAY, or CUSTOM.
durationInMinutesThe duration of time off is determined by the type selected: For FULL_DAY time off, the duration is calculated as CAPACITY_IN_MINUTES / WORKING_DAYS_OF_WEEK, while for HALF_DAY time off, it is calculated as (CAPACITY_IN_MINUTES / WORKING_DAYS_OF_WEEK) / 2. These calculations are based on the user's defined capacity. For CUSTOM type, durationInMinutes is required and must be less than or equal to the user's defined capacity.
createdAtThe timestamp when the time off was created, is represented in epoch milliseconds.
createdByThe user who created the time off