Employees Object

---

id

string

REQUIRED · 

The unique identifier for employees

employee_number

string

This represents the employee number

company

object

This represents the company

id

string

The unique identifier for companies

first_name

string

This represents the first name of the employee

middle_name

string

This represents the middle name of the employee

last_name

string

This represents the last name of the employee

name

string

This represents the name of the employee

username

string

This represents the username

groups

object[]

This represents the groups

id

string

The unique identifier for groups

name

string

Group's name

type

string

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

emails

object[]

The emails of the user

email

string

The email address

type

string

The type of email address

is_primary

boolean

Whether the email address is primary

phones

object[]

The phones of the user

number

string

The phone number

extension

string

The extension of the phone number

type

string

The type of phone number

employments

object[]

Represents a role or employment of the employee in the company

id

string

REQUIRED · 

The unique identifier for employments

employee

object

Employee associated with this employment

id

string

The unique identifier for employees

job_title

string

Job title of the employee

pay_rate

number

This represents the pay rate

pay_period

string

This represents the pay period

pay_frequency

string

This represents the pay frequency

pay_currency

string

This represents the pay currency

pay_group

string

This represents the pay group

flsa_status

string

This represents the flsa status

effective_date

string · date-time

Represents the effective date of the employment

end_date

string · date-time

Represents the end date of the employment

employment_type

string

This represents the employment type

All possible enum values:

• full_time
• part_time
• contract
• internship
• temporary
• trainee
• volunteer
• per_diem

end_reason

string

Represents why the employment ended

created_at

string · date-time

This represents the date when the employments was created

updated_at

string · date-time

This represents the date when the employments was updated

home_location

object[]

This represents the home location

id

string

The unique identifier for locations

name

string

This represents the name of the location

street_1

string

The first line of home address

street_2

string

The second line of home address

city

string

The city of the home address

state

string

The state/province of the home address

postal_code

string

The postal code of the home address

country

string

The country of the home address

work_location

object

This represents the work location

id

string

The unique identifier for locations

name

string

This represents the name of the location

street_1

string

The first line of work address

street_2

string

The second line of work address

city

string

The city of the work address

state

string

The state/province of the work address

postal_code

string

The postal code of the work address

country

string

The country of the work address

manager

object

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

id

string

The unique identifier for employees

name

string

This represents the name of the employee

pay_group

object

This represents the pay group

id

string

The unique identifier for pay groups

ssn

string

This represents the ssn

gender

string

This represents gender

ethnicity

string

This represent ethnicity

marital_status

string

This represents marital status

date_of_birth

string

This represents date of birth

start_date

string · date-time

This represents the start date

employment_status

string

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

All possible enum values:

• active
• inactive
• pending

termination_date

string · date-time

This represents the termination date

termination_type

string

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

All possible enum values:

• voluntary
• dismissed
• redundancy
• end_of_contract
• retirement
• mutual

termination_reason

string

Represents the reason for termination

avatar

string

This represents the avatar

tags

object[]

The employee's tags

id

string

The tag's unique identifier

name

string

The tag's name

created_at

string · date-time

This represents the date when the Employee was created

updated_at

string · date-time

This represents the date when the Employee was updated

remote_data

object

Raw data returned from the remote API call.