hris
employee

List all employees

get/hris/{connection_id}/employee

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/hris/{connection_id}/employee
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to HrisCompany)

group_idstring

The group ID to filter by (reference to HrisGroup)

location_idstring

The location ID to filter by (reference to HrisLocation)

job_idstring

The job ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
first_namestring
last_namestring
titlestring
job_idstring

the hris_job (position) this employee holds; their primary job when they hold more than one

manager_idstring
employment_status'ACTIVE' | 'INACTIVE'
gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
date_of_birthstring date-time

YYYYMM/DD

employee_numberstring

the company's ID for this employee

hired_atstring date-time

The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

terminated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

termination_reasonstring
marital_status'MARRIED' | 'SINGLE'
employment_type'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
language_localestring
currencystring
timezonestring
image_urlstring

This link expires after 1 hour.

company_idstring

(reference to HrisCompany)

pronounsstring
employee_rolesstring[]
salutationstring

Mr. Mrs. Ms.

biostring
ssn_sinstring
storage_quota_allocatednumber
storage_quota_usednumber
storage_quota_availablenumber
has_mfaboolean

does the user/employee have multi-factor authentication enabled

timeoff_days_totalnumber

Total time off allowance for the current leave period, in days (when reported by the provider)

timeoff_days_usednumber

Time off days used or booked in the current leave period (when reported by the provider)

flsa_status'EXEMPT' | 'NON_EXEMPT' | 'SALARIED_NONEXEMPT' | 'OWNER'

US Fair Labor Standards Act classification

pay_frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

how often the employee is paid (eg. BIWEEKLY)

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.