Sign in
hris
employee

List all employees

get/hris/{connection_id}/employee

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

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

sortstring
orderstring
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)

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
updated_atstring date-time
namestring
first_namestring
last_namestring
titlestring
manager_idstring
employment_status'ACTIVE' | 'INACTIVE'
gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
date_of_birthstring date-time
employee_numberstring
hired_atstring date-time
terminated_atstring date-time
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
company_idstring
pronounsstring
employee_rolesstring[]
salutationstring
biostring
ssn_sinstring
storage_quota_allocatednumber
storage_quota_usednumber
storage_quota_availablenumber
has_mfaboolean
timeoff_days_totalnumber
timeoff_days_usednumber
rawobject

Changes

Changed in 1 of the 34 revisions of this API.2

  • 021e9b45420a2See the full diff
    • ●

      added the new EMPLOYEE enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new USER enum value to the // response property for the response status

      response-property-enum-value-added