---
title: "List HRIS Employees"
method: GET
path: "/api/v2/core/hris-systems/{systemId}/hris-employees"
tags: ["HRIS Employee"]
---

# List HRIS Employees

`GET /api/v2/core/hris-systems/{systemId}/hris-employees`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/core/hris-systems/{systemId}/hris-employees`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/hris-systems/:systemId/hris-employees/get.ts> (a function with typed inputs; its response is checked against the schema)

List call that returns all the employee profiles.

## Path parameters

- `systemId` string, required

## Query parameters

- `start` integer
- `limit` integer
- `filterQuery` string
- `query` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` HRISEmployeeSchema[]
    - `employeeType` string, nullable: Type of the employee
    - `locationCountry` string, nullable: The location country of the employee
    - `bonusAmount` integer, nullable: The amount of the bonus of the employee
    - `middleName` string, nullable: Middle name of the employee
    - `employmentStatus` string, nullable: Current employment status
    - `managerEmail` string, nullable: The email of the manager
    - `positionCriticality` string[], nullable: The criticality of the position of the employee
    - `isContingent` boolean, nullable: Is contingent
    - `bonusAmountCurrency` string, nullable: The currency of the bonus given to the employee
    - `location` string, nullable: The location of the employee
    - `badges` EmployeeBadge[], nullable: The badges of the employee
      - `badgeId` string, nullable: The id of the badge
      - `userId` string, nullable: The user id the badge belongs to.
      - `creator` string, nullable: The creator of the badge
      - `photoUrl` string, nullable: The photo url
      - `lastModifiedTs` integer, nullable: The last modified timestamp of the badge
      - `photoContent` PhotoContent
        - `extension` string, nullable: The extension of the photo
        - `content` string, nullable: The actual string content
        - `isBase64` boolean, nullable: Is the content base 64 encoded
      - `comment` string, nullable: comment on the badge
      - `title` string, nullable: The title of the badge
    - `firstName` string, nullable: First Name of employee
    - `mobility` EmployeeMobility
      - `comments` string, nullable: The comments
      - `travelPercentageMin` number, float, nullable: The min travel percentage
      - `relocationLocations` string[], nullable: The relocation locations
      - `relocation` string, nullable: The relocation information
      - `travel` string, nullable: The travel detail
      - `travelPercentageMax` number, float, nullable: The max travel percentage
    - `bu` string, nullable: The Business unit of the employee
    - `email` string, nullable: List of Emails of the employee comma seperated
    - `bonusAmountFrequency` string, nullable: The frequency of the bonus pay to the employee
    - `basePayCurrency` string, nullable: The currency of the base pay of the employee
    - `basePay` Pay
      - `frequency` string, nullable: The frequency of pay
      - `amount` number, float, nullable: The amount of pay
      - `currency` string, nullable: The currency of pay in ISO format
    - `level` string, nullable: The job level of the employee
    - `maritalStatus` string, nullable: Marital status of the employee
    - `terminationType` string, nullable: Type of termination (voluntary / involuntary)
    - `userId` string, nullable: The userId of the employee
    - `lastReviewRating` string, nullable: The last review rating of the employee
    - `externalJobId` string, nullable: External job id of the employee
    - `additionalManagers` AdditionalManager[], nullable: The additional managers of the employee
      - `capacityManagerEmail` string, nullable: The email of the capacity manager
      - `employeeId` string, nullable: Employee id of the additional manager in the HRIS system
      - `type` string, nullable: Type of the additional manager (e.g. capacity)
      - `email` string, nullable: Email of the additional manager
    - `customInfo` object, nullable: The custom info captured for the employee by custom fields
    - `employmentDates` EmployeeEmploymentDate[], nullable: Employee lifecycle dates not covered by hiringDate / roleChangeDate / terminationDate, as a typed list of {type, date}
      - `date` string, nullable: The date itself, as YYYY-MM-DD
      - `type` 'original_hire' | 'continuous_service' | 'internal_transfer' | 'probation_end' | 'employment_confirmation' | 'last_working_day' | 'resignation', required: Type of lifecycle date. One of ats.base.EmploymentDateType
    - `tenureYears` number, float, nullable: The total tenure years of the employee
    - `systemId` string, nullable: The system id of the HRIS system in EF
    - `employeeCriticality` EmployeeCriticality
      - `riskOfLoss` string, nullable: The risk of looking the employee
      - `impactOfLoss` string, nullable: The impact of loss of the employee
    - `salutation` string, nullable: Salutation / title prefix (Mr, Ms, Dr, etc.)
    - `companyName` string, nullable: The company name of the employee
    - `phone` string, nullable: The phone number of the employee
    - `employmentBasis` string, nullable: Employment basis (full-time / part-time)
    - `performanceRatings` EmployeePerformanceRating[], nullable: The performance rating of the employee
      - `periodEndDate` string, nullable: The performance period end date
      - `rating` number, float, nullable: The rating given
      - `reviewedBy` User
        - `atsUserGroups` UserGroup[], nullable: The user groups
          - `userGroupId` string, email, nullable
        - `name` string, nullable: The name of the user
        - `atsRoles` string[], nullable: The ats roles
        - `userId` string, nullable: The user id of the user
        - `firstName` string, nullable: The first name of the user
        - `lastName` string, nullable: The last name of the user
        - `email` string, email, nullable: The email of the user
      - `ratingLabel` string, nullable: The rating level
      - `reviewComments` string, nullable: The review comments
      - `periodStartDate` string, nullable: The performance period start date
      - `reviewType` string, nullable: The review type
    - `languages` EmployeeLanguageProficiency[], nullable: The employee language proficiencies
      - `read` string, nullable: The reading proficiency
      - `speak` string, nullable: The speaking proficiency
      - `overall` string, nullable: The overall proficiency
      - `language` string, nullable: The language string
      - `write` string, nullable: The writing proficiency
    - `title` string, nullable: The title of the employee
    - `pronouns` string, nullable: Preferred pronouns of the employee
    - `externalSystemIds` EmployeeExternalSystemId[], nullable: The employee's identifier in each external system (payroll vendor, etc.), as a typed list of {type, value}
      - `type` 'paylocity' | 'greythr', required: External system holding the id. One of ats.base.ExternalSystemType
      - `value` string, nullable: Identifier of the employee in that system
    - `id` string, nullable: The unique id of the Employee in the HRIS system
    - `terminationDate` string, nullable: The termination date of the employee
    - `hiringDate` string, nullable: The hiring date of the employee
    - `managerUserId` string, nullable: The user id of the manager in HRIS system
    - `citizenship` string[], nullable: Citizenships held by the employee (a list, to carry dual citizenship)
    - `preferredLastName` string, nullable: Last name the employee goes by
    - `terminationRegrettable` string, nullable: Whether the termination was regrettable
    - `successionPlan` EmployeeSuccessionPlan
      - `comments` string, nullable: The comments
      - `planDate` string, nullable: The date of the plan
      - `planName` string, nullable: The name of the plan
      - `successors` EmployeeSuccessor[], nullable: The successors of an employee
        - `employeeDetails` User
          - `atsUserGroups` UserGroup[], nullable: The user groups
            - `userGroupId` string, email, nullable
          - `name` string, nullable: The name of the user
          - `atsRoles` string[], nullable: The ats roles
          - `userId` string, nullable: The user id of the user
          - `firstName` string, nullable: The first name of the user
          - `lastName` string, nullable: The last name of the user
          - `email` string, email, nullable: The email of the user
        - `readiness` string, nullable: The readiness of the successor
        - `rank` integer, nullable: The rank
        - `comments` string, nullable: The comments
    - `bonus` Pay
      - `frequency` string, nullable: The frequency of pay
      - `amount` number, float, nullable: The amount of pay
      - `currency` string, nullable: The currency of pay in ISO format
    - `lastActivityTs` integer, nullable: The last activity timestamp
    - `managerFullname` string, nullable: The full name of the manager
    - `rehireEligibility` string, nullable: Rehire eligibility status of the employee
    - `jobCode` string, nullable: The job code of the employee
    - `timezone` string, nullable: Working time zone
    - `tenureCurrentRoleYears` number, float, nullable: The no of years the employee is in current role
    - `basePayFrequency` string, nullable: The frequency of the base pay of the employee
    - `shift` string, nullable: Shift label (morning / evening / night / general)
    - `lob` string, nullable: The lob of the employee
    - `roleChangeDate` string, nullable: The last role change date of the employee
    - `preferredFirstName` string, nullable: First name the employee goes by
    - `role` string, nullable: The role of the employee
    - `eligibleForTransfer` boolean, nullable: Is the employee eligible for transfer or not
    - `workplaceModel` string, nullable: Workplace model (office / hybrid / remote)
    - `lastName` string, nullable: Last Name of employee
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

## Changes

- **2026-11-03** `9a8b3a927e93`: 43 warning, 2 info
  - removed the optional property `additionalManagers` from the response with the `200` status
  - removed the optional property `badges` from the response with the `200` status
  - removed the optional property `basePay` from the response with the `200` status
  - removed the optional property `basePayCurrency` from the response with the `200` status
  - …41 more

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/core/hris-systems/:systemId/hris-employees/get.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)