Sign in
Time Off (Beta)

Time-Off Events

Beta: This endpoint is in beta and may change. Read time-off requests, approvals, and taken time-off

get/employer/time-off-events

Query parameters

individual_idstring uuid

Filter by individual employee ID

policy_type'pto' | 'sick' | 'parental' | 'unpaid' | 'other'

Filter by policy type

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

Time-off events for employees

idstring uuid required

Unique identifier for the time-off event.

source_idstring nullable required

The provider's unique identifier for this time-off event.

individual_idstring uuid required

A stable Finch id (UUID v4) for an individual in the company.

reviewer_idstring uuid nullable required

The ID of the employee who reviewed/approved this request.

status'requested' | 'approved' | 'declined' | 'cancelled' | 'deleted' required

The status of the time-off request.

policy_type'pto' | 'sick' | 'parental' | 'unpaid' | 'other' | 'null' nullable required

The type of time-off policy.

source_policy_typestring nullable required

The raw policy type as defined by the provider.

event_type'vacation' | 'sick' | 'personal' | 'jury_duty' | 'volunteer' | 'bereavement' | 'other' required

The specific type of time-off event.

source_event_typestring required

The raw event type as defined by the provider.

start_datestring date-time nullable required

ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS). Default timestamps for start_date and end_date are 00:00:00 (beginning of day) and 23:59:59 (end of day), respectively. Note: Datetime values are represented in the timezone they are reflected in the provider.

end_datestring date-time nullable required

ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS). Default timestamps for start_date and end_date are 00:00:00 (beginning of day) and 23:59:59 (end of day), respectively. Note: Datetime values are represented in the timezone they are reflected in the provider.

Changes