HRIS API

Employees

Companies

Departments

Payrolls

Employee Payrolls

Employee Schedules

Time Off Requests

Get the HR Support your business needs - if you are looking for a way to improve your HR operations, consider partnering with the HR experts at HR Works.

connection

HR Works

Code

The date and time when the object was created.

Created at (timestamp)

Created by

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

Description

Name

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

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

critical

edge-case

Birth Date

Company ID

Company name

compensation

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

Country Code

medium

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

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

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

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

Indicates if the employee works from a remote location.

Remote

Employee ID

Employee note

Manager note

Policy ID

Status

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

x-apideck-app-id

company_id

ID of the consumer which you want to get or push data from

x-apideck-consumer-id

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

cursor

employee_id

filter

sort

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

fields

job_id

Number of results to return. Minimum 1, Maximum 200, Default 20

limit

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

pass_through

payroll_id

Include raw response. Mostly used for debugging purposes

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-service-id

Name of the contact person at the address

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

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

Notes

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

Contains parameter or domain specific information related to the error and why it occurred.

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

A human-readable message providing more details about the error.

The name which you used in opening your bank account.

Bank Account Name

A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.

Bank Account Number

Account Type

A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

Bank Code

Bank Name

A branch identifier is a unique identifier for a branch of a bank or financial institution.

Branch Identifier

A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.

BSB Number

The International Bank Account Number (IBAN).

A routing number is a nine-digit code used to identify a financial institution in the United States.

Routing number

An array of employee benefits for the pay period.

An array of employee deductions for the pay period.

The employee's gross pay. Only available when payroll has been processed

The employee's net pay. Only available when payroll has been processed

An array of employer and employee taxes for the pay period.

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

Currency

UNKNOWN_CURRENCY

The date on which a change to an employee's compensation takes effect.

Effective date

The ID of the job to which the compensation belongs.

Job ID

Rate

The rate of pay for the employee in their current job role.

The compensation rate of the job.

The date on which the employee leaves or is expected to leave their current job role.

The end date of the job.

The date on which the employee was hired by the organization

Hired date

Indicates whether this the employee has a manager role.

Manager

Indicates whether this the employee's primary job.

Primary

The date on which the employee starts working in their current job role.

The start date of the job.

The date on which employees will be paid for the payroll.

An array of compensations for the payroll.

The end date, inclusive, of the pay period.

Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.

The start date, inclusive, of the pay period.

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

Company number

The position and responsibilities of the person within the organization.

Job role

Links to navigate to previous or next pages through the API

Link to navigate to the current page through the API

Link to navigate to the previous page through the API

Simple object allowing any properties for direct extension.

Array of objects for structured data modifications via paths.

Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.

Identifier for the service to which this pass_through should be applied.

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Payment Frequency

Unit of measurement for employee compensation.

Payment Unit

The total amount of employee deducted benefits for the payroll.

HR Works

Supported resources

Details

Employees

Supported detail fields (45)

Supported list fields (44)

Supported filters