Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Employee

employee

Scopes: export_company_info

get/v{version}/employees/{id}

Path parameters

idstring required
versionstring required

Response

OK

idstring

The id of the employee.

company_idstring

The company id of the employee.

languagestring

The employee's language.

tobaccostring

The employee's tobacco usage.

disabledboolean

The employee's disabled status.

latest_hire_datestring

The employee's latest hiredate.

enrollment_status'Not Started' | 'In Progress' | 'Finished'

The employee's enrollment status

last_loginstring date-time

The last login timestamp, in UTC.

compensation_type'Salary' | 'Hourly'

Current Compensation Type, only required for Compensation changes.

compensationnumber double

Current Compensation, only required for Compensation changes.

compensation_start_datestring

Current Compensation Start Date, only required for Compensation changes.

compensation_end_datestring

Current Compensation End Date, only relevant for Compensation changes.

eidstring

External identifier for importing purposes. Auto-assigned if not provided.

payroll_idstring

External Payroll Id.

type'Full-Time' | 'Part-Time' | 'Variable-Hour' | 'Contractor' | 'Seasonal' | 'Intern' required

Type

status'Active' | 'Leave of Absence' | 'COBRA' | 'Terminated' | 'Resigned' | 'Deceased' | 'Retired' | 'Applicant' | 'Test' required

Status.

status_effective_datestring

The effective date of the status change, only required for status updates.

status_reasonstring

The reason recorded for the status change, only required for status updates.

termination_type'Involuntary' | 'Voluntary' | 'Gross Misconduct'

Type of termination, only required when status is terminated.

ssnstring required

Social Security Number.

first_namestring required

First Name.

middle_namestring

Middle Name.

last_namestring required

Last Name.

emailstring

Email Address.

birth_datestring

Date of Birth.

gender'Male' | 'Female' | ''

Gender.

personal_emailstring

Personal Email Address.

home_phonestring

Home Phone Number.

mobile_phonestring

Mobile Phone Number.

work_phonestring

Work Phone Number.

marital'' | 'Single' | 'Married' | 'Divorced' | 'Domestic Partner' | 'Legally Separated' | 'Widowed'

Marital Status.

hire_datestring

If the employee is not terminated, the latest HireDate is returned, otherwise the employee's OriginalHireDate.

job_titlestring

The employee's job title.

hoursnumber double

Hours.

pay_cycle'Annually' | '2 Pay Periods' | '3 Pay Periods' | '4 Pay Periods' | '5 Pay Periods' | '6 Pay Periods' | '7 Pay Periods' | '8 Pay Periods' | '9 Pay Periods' | '10 Pay Periods' | '11 Pay Periods' | 'Monthly' | '13 Pay Periods' | '14 Pay Periods' | '15 Pay Periods' | '16 Pay Periods' | '17 Pay Periods' | '18 Pay Periods' | '19 Pay Periods' | '20 Pay Periods' | '21 Pay Periods' | '22 Pay Periods' | '23 Pay Periods' | 'Semi-Monthly' | '25 Pay Periods' | 'Bi-Weekly' | '27 Pay Periods' | '28 Pay Periods' | '29 Pay Periods' | '30 Pay Periods' | '31 Pay Periods' | '32 Pay Periods' | '33 Pay Periods' | '34 Pay Periods' | '35 Pay Periods' | '36 Pay Periods' | '37 Pay Periods' | '38 Pay Periods' | '39 Pay Periods' | '40 Pay Periods' | '41 Pay Periods' | '42 Pay Periods' | '43 Pay Periods' | '44 Pay Periods' | '45 Pay Periods' | '46 Pay Periods' | '47 Pay Periods' | '48 Pay Periods' | '49 Pay Periods' | '50 Pay Periods' | '51 Pay Periods' | 'Weekly'

Pay Cycle.

Example response

{
  "latest_hire_date": "yyyy-MM-dd",
  "compensation_start_date": "yyyy-MM-dd",
  "compensation_end_date": "yyyy-MM-dd",
  "status_effective_date": "yyyy-MM-dd",
  "birth_date": "yyyy-MM-dd",
  "hire_date": "yyyy-MM-dd"
}