GET
/
employer
/
time-off-balances
Time-Off Balances
curl --request GET \
  --url https://api.tryfinch.com/employer/time-off-balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
[
  {
    "individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
    "policy_type": "pto",
    "source_policy_type": "Vacation",
    "units": "hours",
    "used": 40,
    "total": 160
  },
  {
    "individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
    "policy_type": "sick",
    "source_policy_type": "Sick Leave",
    "units": "hours",
    "used": 8,
    "total": 40
  }
]

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 balances for employees

Array of time-off balances for employees.

​
individual_id
string<uuid>
required

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

​
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.

​
units
enum<string>
required

The units for the time-off amount.

Available options:
days,
hours,
minutes
​
used
integer | null
required

Total amount used for this policy.

​
total
integer | null
required

Total amount allocated for this policy.