GET
/
employer
/
time-off-events
Time-Off Events
curl --request GET \
  --url https://api.tryfinch.com/employer/time-off-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_id": "<string>",
    "individual_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reviewer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "requested",
    "policy_type": "pto",
    "source_policy_type": "<string>",
    "event_type": "vacation",
    "source_event_type": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string<date>
default:2020-09-17
required

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

Query Parameters

​
individual_id
string<uuid>

Filter by individual employee ID

​
policy_type
enum<string>

Filter by policy type

Available options:
pto,
sick,
parental,
unpaid,
other

Response

Time-off events for employees

Array of time-off events for employees.

​
id
string<uuid>
required

Unique identifier for the time-off event.

​
source_id
string | null
required

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

​
individual_id
string<uuid>
required

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

​
reviewer_id
string<uuid> | null
required

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

​
status
enum<string>
required

The status of the time-off request.

Available options:
requested,
approved,
declined,
cancelled,
deleted
​
policy_type
enum<string> | null
required

The type of time-off policy.

Available options:
pto,
sick,
parental,
unpaid,
other
​
source_policy_type
string | null
required

The raw policy type as defined by the provider.

​
event_type
enum<string>
required

The specific type of time-off event.

Available options:
vacation,
sick,
personal,
jury_duty,
volunteer,
bereavement,
other
​
source_event_type
string
required

The raw event type as defined by the provider.

​
start_date
string<date-time> | null
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_date
string<date-time> | null
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.