Skip to content

Employees Object

Relationships

Schema relationships 
graph LR
    Employees -->|"company"| Companies
    Employees -->|"groups"| Groups
    Employees -->|"employments"| Employments
    Employees -->|"home_location"| Locations
    Employees -->|"work_location"| Locations
    Employees -->|"pay_group"| PayGroups
    Employees -->|"tags"| Tags

Properties

idstring
required·

The unique identifier for employees

avatarstring

This represents the avatar

companyobject

This represents the company

References: Companies → id
idstring

The unique identifier for companies

created_atstring · date-time

This represents the date when the Employee was created

date_of_birthstring

This represents date of birth

emailsobject[]

The emails of the user

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employee_numberstring

This represents the employee number

employment_statusstring

This represents the employment status. If no clear mapping is available, then the raw value is returned.

Possible values:
activeinactivepending
employmentsobject[]

Represents a role or employment of the employee in the company

References: Employments → id
idstring
required·

The unique identifier for employments

created_atstring · date-time

This represents the date when the employments was created

effective_datestring · date-time

Represents the effective date of the employment

employeeobject

Employee associated with this employment

1 property
idstring

The unique identifier for employees

employment_typestring

This represents the employment type

Possible values:
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
end_datestring · date-time

Represents the end date of the employment

end_reasonstring

Represents why the employment ended

flsa_statusstring

This represents the flsa status

job_titlestring

Job title of the employee

pay_currencystring

This represents the pay currency

pay_frequencystring

This represents the pay frequency

pay_groupstring

This represents the pay group

pay_periodstring

This represents the pay period

pay_ratenumber

This represents the pay rate

updated_atstring · date-time

This represents the date when the employments was updated

etagstring

The unique identifier for the specific version of the resource.

ethnicitystring

This represent ethnicity

first_namestring

This represents the first name of the employee

genderstring

This represents gender

groupsobject[]

This represents the groups

References: Groups → id
idstring

The unique identifier for groups

namestring

Group's name

typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

home_locationobject[]

This represents the home location

References: Locations → id
citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

job_titlestring

Job title of the employee

last_namestring

This represents the last name of the employee

managerobject

Represents the manager of the employee. Is also an employee.

idstring

The unique identifier for employees

namestring

This represents the name of the employee

marital_statusstring

This represents marital status

middle_namestring

This represents the middle name of the employee

namestring

This represents the name of the employee

pay_groupobject

This represents the pay group

References: PayGroups → id
idstring

The unique identifier for pay groups

phonesobject[]

The phones of the user

extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

ssnstring

This represents the ssn

start_datestring · date-time

This represents the start date

tagsobject[]

The employee's tags

References: Tags → id
idstring

The tag's unique identifier

namestring

The tag's name

termination_datestring · date-time

This represents the termination date

termination_reasonstring

Represents the reason for termination

termination_typestring

Represents the type of termination. If no clear mapping exists, then raw value is returned.

Possible values:
voluntarydismissedredundancyend_of_contractretirementmutual
updated_atstring · date-time

This represents the date when the Employee was updated

usernamestring

This represents the username

work_locationobject

This represents the work location

References: Locations → id
citystring

The city of the work address

countrystring

The country of the work address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the work address

statestring

The state/province of the work address

street_1string

The first line of work address

street_2string

The second line of work address