| id |
str, none_type |
A unique identifier for an object. |
[optional] |
| first_name |
str, none_type |
The first name of the person. |
[optional] |
| last_name |
str, none_type |
The last name of the person. |
[optional] |
| middle_name |
str, none_type |
Middle name of the person. |
[optional] |
| display_name |
str, none_type |
The name used to display the employee, often a combination of their first and last names. |
[optional] |
| preferred_name |
str, none_type |
The name the employee prefers to be addressed by, which may be different from their legal name. |
[optional] |
| initials |
str, none_type |
The initials of the person, usually derived from their first, middle, and last names. |
[optional] |
| salutation |
str, none_type |
A formal salutation for the person. For example, 'Mr', 'Mrs' |
[optional] |
| title |
str, none_type |
The job title of the person. |
[optional] |
| marital_status |
str, none_type |
The marital status of the employee. |
[optional] |
| partner |
Person |
|
[optional] |
| division |
str, none_type |
The division the person is currently in. Usually a collection of departments or teams or regions. |
[optional] |
| division_id |
str, none_type |
Unique identifier of the division this employee belongs to. |
[optional] |
| department |
str, none_type |
The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field. |
[optional] |
| department_id |
str, none_type |
Unique identifier of the department ID this employee belongs to. |
[optional] |
| department_name |
str, none_type |
Name of the department this employee belongs to. |
[optional] |
| team |
Team |
|
[optional] |
| company_id |
str, none_type |
The unique identifier of the company. |
[optional] |
| company_name |
str, none_type |
The name of the company. |
[optional] |
| employment_start_date |
str, none_type |
A Start Date is the date that the employee started working at the company |
[optional] |
| employment_end_date |
str, none_type |
An End Date is the date that the employee ended working at the company |
[optional] |
| leaving_reason |
str, none_type |
The reason because the employment ended. |
[optional] |
| employee_number |
str, none_type |
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. |
[optional] |
| employment_status |
EmploymentStatus |
|
[optional] |
| employment_role |
EmployeeEmploymentRole |
|
[optional] |
| ethnicity |
str, none_type |
The ethnicity of the employee |
[optional] |
| manager |
EmployeeManager |
|
[optional] |
| direct_reports |
[str], none_type |
Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee. |
[optional] |
| social_security_number |
str, none_type |
A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. |
[optional] |
| birthday |
date, none_type |
The date of birth of the person. |
[optional] |
| deceased_on |
date, none_type |
The date the person deceased. |
[optional] |
| country_of_birth |
Country |
|
[optional] |
| description |
str, none_type |
A description of the object. |
[optional] |
| gender |
Gender |
|
[optional] |
| pronouns |
str, none_type |
The preferred pronouns of the person. |
[optional] |
| preferred_language |
str, none_type |
language code according to ISO 639-1. For the United States - EN |
[optional] |
| languages |
[str, none_type] |
|
[optional] |
| nationalities |
[str, none_type] |
|
[optional] |
| photo_url |
str, none_type |
The URL of the photo of a person. |
[optional] |
| timezone |
str, none_type |
The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London. |
[optional] |
| source |
str, none_type |
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. |
[optional] |
| source_id |
str, none_type |
Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS). |
[optional] |
| record_url |
str, none_type |
|
[optional] |
| jobs |
[EmployeeJob], none_type |
|
[optional] |
| compensations |
[EmployeeCompensation], none_type |
|
[optional] |
| works_remote |
bool, none_type |
Indicates if the employee works from a remote location. |
[optional] |
| addresses |
[Address] |
|
[optional] |
| phone_numbers |
[PhoneNumber] |
|
[optional] |
| emails |
[Email] |
|
[optional] |
| custom_fields |
[CustomField] |
|
[optional] |
| social_links |
[SocialLink] |
|
[optional] |
| bank_accounts |
[BankAccount] |
|
[optional] |
| tax_code |
str, none_type |
|
[optional] |
| tax_id |
str, none_type |
|
[optional] |
| dietary_preference |
str, none_type |
Indicate the employee's dietary preference. |
[optional] |
| food_allergies |
[str], none_type |
Indicate the employee's food allergies. |
[optional] |
| probation_period |
ProbationPeriod |
|
[optional] |
| tags |
Tags |
|
[optional] |
| custom_mappings |
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type |
When custom mappings are configured on the resource, the result is included here. |
[optional] [readonly] |
| row_version |
str, none_type |
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. |
[optional] |
| deleted |
bool, none_type |
Flag to indicate if the object is deleted. |
[optional] |
| updated_by |
str, none_type |
The user who last updated the object. |
[optional] [readonly] |
| created_by |
str, none_type |
The user who created the object. |
[optional] [readonly] |
| updated_at |
datetime, none_type |
The date and time when the object was last updated. |
[optional] [readonly] |
| created_at |
datetime, none_type |
The date and time when the object was created. |
[optional] [readonly] |
| pass_through |
PassThroughBody |
|
[optional] |