List all employees

Updated:

GET/hris/{connection_id}/employee

Returns a list of HrisEmployees. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
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 array
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
connection_idstring required
ID of the connection

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The employee's full name
first_namestring
The employee's first (given) name
last_namestring
The employee's last (family) name
emails array
The employee's email addresses
titlestring
job_idstring
the hris_job (position) this employee holds; their primary job when they hold more than one
manager_idstring
employment_status enum
Valid values:
"ACTIVE"
"INACTIVE"
gender enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
telephones array
date_of_birthdate-time
YYYYMM/DD
employee_numberstring
the company's ID for this employee
hired_atdate-time
The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
terminated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
termination_reasonstring
marital_status enum
Valid values:
"MARRIED"
"SINGLE"
employment_type enum
Valid values:
"FULL_TIME"
"PART_TIME"
"CONTRACTOR"
"INTERN"
"CONSULTANT"
addressobject
language_localestring
currencystring
timezonestring
image_urlstring
This link expires after 1 hour.
company_idstring
(reference to HrisCompany)
pronounsstring
employee_roles enum array
Valid values:
"ADMIN"
"MANAGER"
"RECRUITER"
"SALESREP"
"INTERVIEWER"
compensation array
salutationstring
Mr. Mrs. Ms.
biostring
ssn_sinstring
groups array
Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email.
locations array
metadata array
storage_quota_allocatednumber
storage_quota_usednumber
storage_quota_availablenumber
relationships array
the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)
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 enum
Valid values:
"EXEMPT"
"NON_EXEMPT"
"SALARIED_NONEXEMPT"
"OWNER"
US Fair Labor Standards Act classification
pay_frequency enum
Valid values:
"ONE_TIME"
"DAY"
"QUARTER"
"YEAR"
"HOUR"
how often the employee is paid (eg. BIWEEKLY)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/employee',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-22T02:53:46.010Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    company_id: '',
    group_id: '',
    location_id: '',
    job_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?