Time Off

get_time_off_requests

Get list of time-off requests for the authenticated user's organization

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for request description

relationsArray<string>

Relations to include (e.g., ["employee", "policy", "approvedBy"])

statusstringREQUESTEDAPPROVEDDENIEDCANCELLED

Filter by request status

employeeIdstring<uuid>

Filter by employee ID

policyIdstring<uuid>

Filter by policy ID

startDatestring

Filter requests from this date (ISO format)

endDatestring

Filter requests until this date (ISO format)

get_time_off_request_count

Get time-off request count in the authenticated user's organization

Parameters

statusstringREQUESTEDAPPROVEDDENIEDCANCELLED

Filter by request status

employeeIdstring<uuid>

Filter by employee ID

policyIdstring<uuid>

Filter by policy ID

startDatestring

Filter requests from this date (ISO format)

endDatestring

Filter requests until this date (ISO format)

get_time_off_request

Get a specific time-off request by ID

Parameters

idstring<uuid>required

The time-off request ID

relationsArray<string>

Relations to include (e.g., ["employee", "policy", "approvedBy"])

create_time_off_request

Create a new time-off request in the authenticated user's organization

Body

application/json
request_dataobjectrequired

The data for creating the time-off request

Show child attributes
startDatestringrequired

The start date (required)

endDatestringrequired

The end date (required)

employeeIdstringrequired

The employee ID (required)

policyIdstringrequired

The policy ID (required)

[key: string]any

update_time_off_request

Update an existing time-off request

Parameters

idstring<uuid>required

The time-off request ID

request_dataobjectrequired

The data for updating the time-off request

delete_time_off_request

Delete a time-off request

Parameters

idstring<uuid>required

The time-off request ID

approve_time_off_request

Approve a time-off request

Parameters

idstring<uuid>required

The time-off request ID

deny_time_off_request

Deny a time-off request

Parameters

idstring<uuid>required

The time-off request ID

reasonstring

Reason for denial

cancel_time_off_request

Cancel a time-off request

Parameters

idstring<uuid>required

The time-off request ID

get_my_time_off_requests

Get time-off requests for the current authenticated user

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstringREQUESTEDAPPROVEDDENIEDCANCELLED

Filter by request status

policyIdstring<uuid>

Filter by policy ID

startDatestring

Filter requests from this date (ISO format)

endDatestring

Filter requests until this date (ISO format)

relationsArray<string>

Relations to include

get_pending_time_off_requests

Get pending time-off requests for the authenticated user's organization

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

employeeIdstring<uuid>

Filter by employee ID

policyIdstring<uuid>

Filter by policy ID

relationsArray<string>

Relations to include

get_time_off_policies

Get list of time-off policies for the authenticated user's organization

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for policy name

relationsArray<string>

Relations to include (e.g., ["employees"])

typestringVACATIONSICK_LEAVEPERSONALMATERNITYPATERNITYBEREAVEMENTOTHER

Filter by policy type

requiresApprovalboolean

Filter by approval requirement

paidboolean

Filter by paid status

get_time_off_policy

Get a specific time-off policy by ID

Parameters

idstring<uuid>required

The time-off policy ID

relationsArray<string>

Relations to include (e.g., ["employees"])

create_time_off_policy

Create a new time-off policy in the authenticated user's organization

Body

application/json
policy_dataobjectrequired

The data for creating the time-off policy

Show child attributes
namestringrequired

The policy name (required)

typestringrequired

The policy type (required)

[key: string]any

update_time_off_policy

Update an existing time-off policy

Parameters

idstring<uuid>required

The time-off policy ID

policy_dataobjectrequired

The data for updating the time-off policy

delete_time_off_policy

Delete a time-off policy

Parameters

idstring<uuid>required

The time-off policy ID

assign_employees_to_time_off_policy

Assign employees to a time-off policy

Parameters

policyIdstring<uuid>required

The time-off policy ID

employeeIdsArray<string>required

Array of employee IDs to assign

get_time_off_balance

Get time-off balance for an employee

Parameters

employeeIdstring<uuid>required

The employee ID

policyIdstring<uuid>

Filter by specific policy ID

yearnumber

Filter by specific year

get_my_time_off_balance

Get time-off balance for the current authenticated user

Parameters

policyIdstring<uuid>

Filter by specific policy ID

yearnumber

Filter by specific year

get_time_off_statistics

Get time-off statistics for the authenticated user's organization

Parameters

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

employeeIdstring<uuid>

Filter by specific employee ID

policyIdstring<uuid>

Filter by specific policy ID

typestringVACATIONSICK_LEAVEPERSONALMATERNITYPATERNITYBEREAVEMENTOTHER

Filter by time-off type

groupBystringemployeepolicytypemonth

Group statistics by

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey