HRIS API

Employees

Companies

Departments

Payrolls

Employee Payrolls

Employee Schedules

Time Off Requests

Modern HR platform for managing employees, company data and time off.

connection

Hailey HR

edge-case

Birth Date

Company ID

Company name

compensation

Country code according to ISO 3166-1 alpha-2.

Country Code

The date and time when the object was created.

Created at (timestamp)

Created by

medium

When custom mappings are configured on the resource, the result is included here.

Deceased Date

Flag to indicate if the object is deleted.

Deleted

The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.

Department

Unique identifier of the department ID this employee belongs to.

Department ID

Name of the department this employee belongs to.

Department Name

Description

Indicate the employee's dietary preference.

Dietary preference

Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.

Direct reports

The name used to display the employee, often a combination of their first and last names.

Display name

The division the person is currently in. Usually a collection of departments or teams or regions.

Division

Unique identifier of the division this employee belongs to.

Division ID

The third-party API ID of original entity

An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.

Employee number

An End Date is the date that the employee ended working at the company

Employee end date

Employment sub type

The type of employment relationship the employee has with the organization.

Employment type

A Start Date is the date that the employee started working at the company

Employee start date

The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.

Employment status

First name

Food allergies

The gender represents the gender identity of a person.

Gender

The initials of the person, usually derived from their first, middle, and last names.

Initials

critical

language code according to ISO 639-1. For the United States - EN

Last name

Email address

The name of the manager, often a combination of their first and last names.

Manager name

Marital status

Middle name

The nationality of the person, represented as a two-letter country code according to ISO 3166-1 alpha-2.

Nationality

Person

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Photo URL

The name the employee prefers to be addressed by, which may be different from their legal name.

Preferred name

The date that the employee ended their probation period at the company.

Probation end date

The date that the employee started their probation period at the company.

Probation start date

Probation period

Pronouns

Record URL

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Row version

A formal salutation for the person. For example, 'Mr', 'Mrs'

A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.

Social Security Number

When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.

Source

Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).

Source ID

Tax Code

Tax ID

The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.

Timezone

Job title

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

Indicates if the employee works from a remote location.

Remote

An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.

Company number

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

Code

Name

Employee ID

Employee note

Manager note

Policy ID

Status

The unit of time off requested. Possible values include: `hours`, `days`, or `other`.

Hailey HR supports "parallel employments" (multiple active Employment records per employee). `department_id`, `department_name`, `division`, `division_id`, `company_id`, `company_name`, `title`, `team`, `manager.id`, and `employment_role.type` reflect the primary employment. `employment_start_date`/`employment_end_date` reflect overall company tenure instead — see "Get Employee" for per-employment detail via `jobs[]`.
An employee can also hold multiple titles and belong to multiple teams at once (`titleIds`/`teamIds` arrays). We only return the first of each as `title`/`team`, since the unified schema allows a single value for both.


Hailey HR does not allow duplicate email addresses across employees. Creating an employee with an `emails` value already in use by another employee returns an error.


Hailey HR supports "parallel employments" (an employee can hold more than one active Employment at once, each ranked by `priority`, 1 = primary). Fields sourced from the **primary** employment: `department_id`, `department_name`, `division`, `division_id`, `company_id`, `company_name`, `title`, `team`, `manager.id`, `employment_role.type`, `probation_period.end_date`, and employment-level values in `custom_fields. `employment_start_date`/`employment_end_date` reflect overall company tenure (earliest start / latest-or-open end across ALL employments), not the primary one. Every employment — primary or not — is listed in `jobs[]`, flagged via `is_primary`, with its own `start_date`/`end_date`.

An employee can also hold multiple titles and belong to multiple teams at once (`titleIds`/`teamIds` arrays). We only return the first of each as `title`/`team`, since the unified schema allows a single value for both.

Salaries carry a `history[]` of effective-dated amounts — a raise adds a new dated entry rather than replacing the old one. `compensations[].rate`/`effective_date` reflect the entry with the most recent date that has already passed, not just the last entry added.


HaileyHR returns time off as one entry per calendar day, with no request-level identifier and no date range. Unify surfaces each day as its own time-off request, so start_date always equals end_date. A multi-day booking therefore appears as one request per day rather than a single spanning request. Day-based entries report units `days` (a full day = 1, a half day = 0.5); entries booked in minutes report units `hours` (minutes / 60). Unify does not merge consecutive days into a span: HaileyHR provides no request boundary, so calendar-adjacency alone cannot tell two separate same-reason bookings apart from one longer booking.

Pagination is not supported. HaileyHR's `/TimeOff` returns the full company dataset in a single response with no native paging, and there is no stable per-request identifier to page on. The `limit` and `cursor` parameters are not honored — retrieve the full list in one call.


Hailey HR

Details