| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
JsonNullable<String> | ➖ | A unique identifier for an object. | 12345 |
firstName |
JsonNullable<String> | ➖ | The first name of the person. | Elon |
lastName |
JsonNullable<String> | ➖ | The last name of the person. | Musk |
middleName |
JsonNullable<String> | ➖ | Middle name of the person. | D. |
displayName |
JsonNullable<String> | ➖ | The name used to display the employee, often a combination of their first and last names. | Technoking |
preferredName |
JsonNullable<String> | ➖ | The name the employee prefers to be addressed by, which may be different from their legal name. | Elon Musk |
initials |
JsonNullable<String> | ➖ | The initials of the person, usually derived from their first, middle, and last names. | EM |
salutation |
JsonNullable<String> | ➖ | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
title |
JsonNullable<String> | ➖ | The job title of the person. | CEO |
maritalStatus |
JsonNullable<String> | ➖ | The marital status of the employee. | married |
partner |
Optional<Person> | ➖ | N/A | |
division |
JsonNullable<String> | ➖ | The division the person is currently in. Usually a collection of departments or teams or regions. | Europe |
divisionId |
JsonNullable<String> | ➖ | Unique identifier of the division this employee belongs to. | 12345 |
department |
JsonNullable<String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field. |
R&D |
departmentId |
JsonNullable<String> | ➖ | Unique identifier of the department ID this employee belongs to. | 12345 |
departmentName |
JsonNullable<String> | ➖ | Name of the department this employee belongs to. | 12345 |
team |
JsonNullable<Team> | ➖ | The team the person is currently in. | |
companyId |
JsonNullable<String> | ➖ | The unique identifier of the company. | 23456 |
companyName |
JsonNullable<String> | ➖ | The name of the company. | SpaceX |
employmentStartDate |
JsonNullable<String> | ➖ | A Start Date is the date that the employee started working at the company | 2021-10-26 |
employmentEndDate |
JsonNullable<String> | ➖ | An End Date is the date that the employee ended working at the company | 2028-10-26 |
leavingReason |
JsonNullable<LeavingReason> | ➖ | The reason because the employment ended. | resigned |
employeeNumber |
JsonNullable<String> | ➖ | An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. | 123456-AB |
employmentStatus |
JsonNullable<EmploymentStatus> | ➖ | The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status. | active |
employmentRole |
Optional<EmploymentRole> | ➖ | N/A | |
ethnicity |
JsonNullable<String> | ➖ | The ethnicity of the employee | African American |
manager |
Optional<Manager> | ➖ | N/A | |
directReports |
List<String> | ➖ | Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee. | [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6" ] |
socialSecurityNumber |
JsonNullable<String> | ➖ | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 |
birthday |
LocalDate | ➖ | The date of birth of the person. | 2000-08-12 |
deceasedOn |
LocalDate | ➖ | The date the person deceased. | 2000-08-12 |
countryOfBirth |
JsonNullable<String> | ➖ | Country code according to ISO 3166-1 alpha-2. | US |
description |
JsonNullable<String> | ➖ | A description of the object. | A description |
gender |
JsonNullable<Gender> | ➖ | The gender represents the gender identity of a person. | male |
pronouns |
JsonNullable<String> | ➖ | The preferred pronouns of the person. | she,her |
preferredLanguage |
JsonNullable<String> | ➖ | language code according to ISO 639-1. For the United States - EN | EN |
languages |
List<String> | ➖ | N/A | |
nationalities |
List<String> | ➖ | N/A | |
photoUrl |
JsonNullable<String> | ➖ | The URL of the photo of a person. | https://unavatar.io/elon-musk |
timezone |
JsonNullable<String> | ➖ | The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London. | Europe/London |
source |
JsonNullable<String> | ➖ | 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. | lever |
sourceId |
JsonNullable<String> | ➖ | Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS). | 12345 |
recordUrl |
JsonNullable<String> | ➖ | N/A | https://app.intercom.io/contacts/12345 |
jobs |
List<EmployeeJob> | ➖ | N/A | |
compensations |
List<EmployeeCompensation> | ➖ | N/A | |
worksRemote |
JsonNullable<Boolean> | ➖ | Indicates if the employee works from a remote location. | true |
addresses |
List<Address> | ➖ | N/A | |
phoneNumbers |
List<PhoneNumber> | ➖ | N/A | |
emails |
List<Email> | ➖ | N/A | |
customFields |
List<CustomField> | ➖ | N/A | |
socialLinks |
List<SocialLink> | ➖ | N/A | |
bankAccounts |
List<BankAccount> | ➖ | N/A | |
taxCode |
JsonNullable<String> | ➖ | N/A | 1111 |
taxId |
JsonNullable<String> | ➖ | N/A | 234-32-0000 |
dietaryPreference |
JsonNullable<String> | ➖ | Indicate the employee's dietary preference. | Veggie |
foodAllergies |
List<String> | ➖ | Indicate the employee's food allergies. | [ "No allergies" ] |
probationPeriod |
Optional<ProbationPeriod> | ➖ | N/A | |
tags |
List<String> | ➖ | N/A | [ "New" ] |
customMappings |
JsonNullable<CustomMappings> | ➖ | When custom mappings are configured on the resource, the result is included here. | |
rowVersion |
JsonNullable<String> | ➖ | 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. | 1-12345 |
deleted |
JsonNullable<Boolean> | ➖ | Flag to indicate if the object is deleted. | true |
updatedBy |
JsonNullable<String> | ➖ | The user who last updated the object. | 12345 |
createdBy |
JsonNullable<String> | ➖ | The user who created the object. | 12345 |
updatedAt |
OffsetDateTime | ➖ | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z |
createdAt |
OffsetDateTime | ➖ | The date and time when the object was created. | 2020-09-30T07:43:32.000Z |
passThrough |
List<PassThroughBody> | ➖ | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |