/employees/meta/post

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you’re looking for the employee’s start date, refer to the start_date field.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

hire_datedatetime or nullOptionalDeprecated

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

ssnstring or nullOptional<=100 characters

The employee's social security number.

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

date_of_birthdatetime or nullOptional

The employee's date of birth.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

preferred_namestring or nullOptional

The employee's preferred first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

remote_datalist of objects or nullOptionalRead-only

1	import requests
2
3	url = "https://api.merge.dev/api/hris/v1/employees/meta/post"
4
5	headers = {
6	"X-Account-Token": "X-Account-Token",
7	"Authorization": "Bearer <token>"
8	}
9
10	response = requests.get(url, headers=headers)
11
12	print(response.json())

/employees/meta/post

Authentication

Headers

Response

Field support by integration

1	{
2	"request_schema": {
3	"type": "object",
4	"properties": {
5	"model": {
6	"type": "object",
7	"required": [
8	"last_name",
9	"first_name",
10	"merge_categories",
11	"new_york_city_neighborhood",
12	"favorite_tv_shows",
13	"favorite_watch"
14	],
15	"properties": {
16	"email_addresses": {
17	"type": "array",
18	"items": {
19	"type": "object",
20	"properties": {
21	"value": {
22	"type": "string",
23	"title": "value"
24	},
25	"email_address_type": {
26	"type": "string",
27	"title": "email_address_type"
28	},
29	"integration_params": {
30	"type": "object",
31	"title": "integration_params",
32	"properties": {}
33	},
34	"linked_account_params": {
35	"type": "object",
36	"title": "linked_account_params",
37	"properties": {}
38	}
39	}
40	},