---
title: "(EA) Get Employee [Batch]"
method: GET
path: "/apiHub/coreHR/v2/companies/{companyId}/employees"
tags: ["Employees"]
---

# (EA) Get Employee \[Batch\]

`GET /apiHub/coreHR/v2/companies/{companyId}/employees`

## Request

- Base URL: `https://dc1demogwext.paylocity.com`
- URL: `https://dc1demogwext.paylocity.com/apiHub/coreHR/v2/companies/{companyId}/employees`
- Auth: HTTP bearer

> 🚧 Beta API Version
> This endpoint version is currently in beta and available only to approved early adoption (EA) partners and customers. Do not rely on this version for production workloads unless explicitly authorized.  If you have any feedback, please share with your designated Early Adoption program representative.

The Get Employees [Batch] endpoint allows clients and partners to retrieve batches of employee demographic data for the specified company. It is ideal for syncing third-party systems with employee information from Paylocity. The endpoint supports pagination and several query parameters that allow for more precise control over the data returned:

- **limit** – Specifies the number of employee records to return per call (default: 20) — maximum value 20
- **offset** – Specifies the number of employee records to skip before returning results, enabling pagination through large datasets
- **includeTotalCount** – When set to `true`, returns the total number of matching employees in the `X-Pcty-Total-Count` response header
- **fields** – A comma-separated list that allows selective retrieval of employee data sections. Supported values include:
    - `contact` (name, home address, phone, and email)
    - `sensitive` (SSN, birth date, gender, ethnicity, veteran, and disability information)
    - `workauthorization` (I-9 verification and work authorization details)
    - `rates` (base pay rates and additional pay rates)
    - `employmentinformation` (hire date, seniority, and tax form details)
    - `assignments` (employee assignment records across companies)
    - `position` (job title, position code, supervisor, cost center, and position history)
    - `worklocation` (work address, work phone, and work email)
    - `status` (employment status and status type history)
    - `timelabor` (badge number)
- **filter** – Narrows which employees are returned in the response. Supported fields and operators:
    - `contact.employeeId` with `eq`, `ne`, or `in` (example: `contact.employeeId eq 'A00045678'`)
    - `employmentInformation.taxForm` with `eq`, `ne`, or `in` (example: `employmentInformation.taxForm in ('W2','1099')`)

## Path parameters

- `companyId` string, required

## Query parameters

- `includeTotalCount` boolean
- `limit` integer
- `offset` integer
- `fields` string
- `filter` string

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

OK

- EmployeeResponse[]
  - `contact` ContactDto
    - `employeeId` string, nullable: The Paylocity Employee ID. This is a unique value per Paylocity Company ID.
    - `personId` string, nullable: The Paylocity Person Identifier. This is a unique value used to identify an individual across multiple company assignments.
    - `name` NameDto
      - `firstName` string, nullable: Employee's first name.
      - `lastName` string, nullable: Employee's last name.
      - `middleName` string, nullable: Employee's middle name.
      - `displayName` string, nullable: Employee's preferred name.
      - `salutation` string, nullable: Employee's salutation (e.g. Mr., Mrs., Dr.).
      - `suffix` SuffixCodeDescriptionDto: The name suffix of the employee (e.g. Jr., Sr., III).
        - `code` string, nullable: Code identifying the name suffix.
        - `description` string, nullable: Full text description of the name suffix (e.g. Jr., Sr., III).
      - `priorLastName` string, nullable: Employee's prior last name, if applicable (e.g. maiden name).
    - `address` AddressDto
      - `country` string, nullable: Country employee resides in.
      - `address1` string, nullable: Address for employee, typically number and street address.
      - `address2` string, nullable: Typically additional identifiers for address, such as apartment number or suite.
      - `county` string, nullable: County employee resides in.
      - `city` string, nullable: City employee resides in.
      - `state` string, nullable: State or province employee resides in.
      - `zip` string, nullable: Postal code for employee's address.
    - `homePhone` string, nullable: Employee's home phone number.
    - `mobilePhone` string, nullable: Employee's mobile phone number.
    - `emailAddress` string, nullable: Employee's personal email address.
  - `sensitive` SensitiveDto
    - `ssn` string, nullable: Employee's Social Security Number.
    - `birthDate` string, date-time, nullable: Employee's date of birth.
    - `maritalStatus` MaritalStatusCodeDescriptionDto: The marital status of the employee.
      - `code` string, nullable: Code identifying the marital status.
      - `description` string, nullable: Full text description of the marital status.
    - `ethnicIdentity` EthnicIdentityDto
      - `legalIdentity` EthnicIdentityCodeDescriptionDto: An ethnic identity associated with the employee.
        - `code` string, nullable: Code identifying the ethnic identity.
        - `description` string, nullable: Full text description of the ethnic identity.
      - `identities` EthnicIdentityRecord[], nullable: Array of ethnic identity records associated with the employee.
        - `customIdentityValue` string, nullable: Custom ethnic identity value, used when the employee adds additional identifier information.
        - `identity` EthnicIdentityCodeDescriptionDto: An ethnic identity associated with the employee.
          - `code` string, nullable: Code identifying the ethnic identity.
          - `description` string, nullable: Full text description of the ethnic identity.
    - `gender` GenderDto
      - `legalIdentity` GenderIdentityCodeDescriptionDto: The gender identity of the employee.
        - `code` string, nullable: Code identifying the gender identity.
        - `description` string, nullable: Full text description of the gender identity.
      - `customIdentityValue` string, nullable: Custom gender identity value, used when the employee adds additional identifier information.
      - `identity` GenderIdentityCodeDescriptionDto: The gender identity of the employee.
        - `code` string, nullable: Code identifying the gender identity.
        - `description` string, nullable: Full text description of the gender identity.
      - `identifyAsLegalGender` string, nullable: Indicates whether the employee identifies as their legal gender.
    - `veteran` VeteranDto
      - `status` string, nullable: Employee's veteran status.
      - `notes` string, nullable: Additional notes regarding the employee's veteran status.
    - `disability` DisabilityDto
      - `status` 'no' | 'yes' | 'preferNotToSay': Employee's disability status. Allowable Values: no, yes, preferNotToSay.
      - `notes` string, nullable: Additional notes regarding the employee's disability status.
      - `classifications` DisabilityClassificationCodeDescriptionDto[], nullable: Array of disability classification records.
        - `code` string, nullable: Code identifying the disability classification.
        - `description` string, nullable: Full text description of the disability classification.
  - `workAuthorization` WorkAuthorizationDto
    - `verificationType` string, nullable: Type of work authorization verification (e.g. I-9, E-Verify).
    - `attestedDate` string, date-time, nullable: Date the employee attested to their work authorization.
  - `rates` RatesDto
    - `records` RateRecordDto[], nullable: Array of base rate records including pay type, base rate, pay frequency, and annual salary.
      - `recordType` 'past' | 'current' | 'future': Indicates if the record is a past, current, or future record. Allowable Values: past, current, future.
      - `payType` string, nullable: Employee's hourly or salary pay type.
      - `baseRate` number, double, nullable: Employee's base pay rate.
      - `baseRatePerType` BaseRatePerTypeCodeDescriptionDto: The rate-per type for the base rate (e.g. Hour, Week).
        - `code` string, nullable: Code identifying the base rate per type.
        - `description` string, nullable: Full text description of the base rate per type (e.g. Hour, Week).
      - `payFrequency` PayFrequencyCodeDescriptionDto: The frequency at which the employee is paid (e.g. Bi-Weekly, Monthly).
        - `code` string, nullable: Code identifying the pay frequency.
        - `description` string, nullable: Full text description of the pay frequency (e.g. Bi-Weekly, Monthly).
      - `autoPayType` string, nullable: Auto pay type for the employee. Determines how the employee is automatically paid.
      - `defaultHours` number, double, nullable: Employee's default hours in the pay period.
      - `annualSalary` number, double, nullable: Employee's annual salary.
      - `effectiveDate` string, date-time, nullable: Effective date of the employee's rate change.
      - `changeReason` string, nullable: Change reason for the rate record.
      - `payGrade` PayGradeCodeDescriptionDto: The pay grade assigned to the employee's rate record.
        - `code` string, nullable: Code identifying the pay grade.
        - `description` string, nullable: Full text description of the pay grade.
      - `checkDate` string, date-time, nullable: Check date of the employee's rate change.
      - `autoPayEnabled` boolean, nullable: Indicates if auto pay is enabled.
      - `notes` string, nullable: Additional notes about the pay rate change.
    - `additionalRates` AdditionalRateRecordDto[], nullable: Array of additional pay rate records such as shift differentials and bonuses.
      - `recordType` 'past' | 'current' | 'future': Indicates if the record is a past, current, or future record. Allowable Values: past, current, future.
      - `rate` number, double, nullable: Additional pay rate amount.
      - `effectiveDate` string, date-time, nullable: Effective date of the additional rate record.
      - `changeReason` string, nullable: Change reason for the additional rate.
      - `rateCode` RateCodeCodeDescriptionDto: The code identifying an additional pay rate type (e.g. Shift Differential, Bonus).
        - `code` string, nullable: Code identifying the additional rate type.
        - `description` string, nullable: Full text description of the additional rate type (e.g. Shift Differential, Bonus).
      - `ratePer` RatePerCodeDescriptionDto: The unit by which an additional rate is measured (e.g. Hour, Quarter).
        - `code` string, nullable: Code identifying the rate-per unit.
        - `description` string, nullable: Full text description of the rate-per unit (e.g. Hour, Quarter).
      - `costCenters` CostCenterGroupDto[], nullable: Array of cost center assignments for this additional rate.
        - `costCenter1` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `costCenter2` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `costCenter3` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `effectiveDate` string, date-time, nullable: Effective date of the cost center assignment.
      - `job` string, nullable: Job code associated with the additional rate.
      - `shift` string, nullable: Shift code associated with the additional rate.
      - `notes` string, nullable: Additional notes for the rate record.
      - `beginCheckDate` string, date-time, nullable: Begin check date for the additional rate.
      - `endCheckDate` string, date-time, nullable: End check date for the additional rate.
  - `employmentInformation` EmploymentInformationDto
    - `hireDate` string, date-time, nullable: Employee's hire date.
    - `adjustedSeniorityDate` string, date-time, nullable: Employee's adjusted seniority date.
    - `taxForm` string, nullable: Employee's tax form type (e.g. W-2, 1099).
  - `assignments` AssignmentDto
    - `records` AssignmentRecordDto[], nullable: Array of assignment records for the employee.
      - `companyId` string, nullable: The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
      - `employeeId` string, nullable: The Paylocity Employee ID. This is a unique value per Paylocity Company ID.
      - `hireDate` string, date-time, nullable: Employee's hire date.
      - `employeeStatus` EmployeeStatusCodeDescriptionDto: The employment status of the employee within an assignment (e.g. Active, Probation).
        - `code` string, nullable: Code identifying the employee status.
        - `description` string, nullable: Full text description of the employee status.
  - `position` PositionDto
    - `records` PositionRecordDto[], nullable: Array of position records for the employee.
      - `recordType` 'past' | 'current' | 'future': Indicates if the record is a past, current, or future record. Allowable Values: past, current, future.
      - `effectiveDate` string, date-time, nullable: Effective date of the employee's position change.
      - `positionCode` string, nullable: Employee's position code.
      - `positionDescription` string, nullable: Employee's position description.
      - `positionTitle` string, nullable: Employee's position title.
      - `changeReason` string, nullable: Change reason for the position record.
      - `eeoClassCode` string, nullable: Equal Employment Opportunity (EEO) classification code.
      - `workersCompCode` string, nullable: Workers' compensation code.
      - `homeShift` string, nullable: Employee's home shift.
      - `jobTitle` string, nullable: Employee's job title.
      - `payGroup` string, nullable: Employee's pay group.
      - `clockBadgeNumber` string, nullable: Employee's clock badge number.
      - `isSupervisorReviewer` boolean, nullable: Indicates whether the employee acts as both supervisor and reviewer.
      - `bonusTarget` number, double, nullable: Bonus target amount.
      - `bonusTargetFrequency` string, nullable: Bonus target frequency (e.g., annually, quarterly).
      - `bonusTargetType` string, nullable: Bonus target type (e.g., percentage of salary, fixed amount).
      - `employmentType` EmploymentTypeCodeDescriptionDto: The employment type for a position record (e.g. Full Time, Part Time).
        - `code` string, nullable: Code identifying the employment type.
        - `description` string, nullable: Full text description of the employment type (e.g. Full Time, Part Time).
      - `positionFamilies` PositionFamilyDto[], nullable: Array of position families associated with this position.
        - `code` string, nullable: Position family code.
        - `name` string, nullable: Position family name.
        - `description` string, nullable: Position family description.
        - `active` boolean, nullable: Indicates if the position family is currently active.
      - `supervisor` SupervisorDto
        - `companyId` string, nullable: Supervisor Paylocity Company ID.
        - `assignmentId` string, nullable: Assignment ID of the employee's supervisor.
        - `effectiveDate` string, date-time, nullable: Effective date of the supervisor assignment.
      - `reviewer` ReviewerDto
        - `companyId` string, nullable: Reviewer Paylocity Company ID.
        - `assignmentId` string, nullable: Assignment ID of the employee's reviewer.
        - `effectiveDate` string, date-time, nullable: Effective date of the reviewer assignment.
      - `costCenter` CostCenterGroupDto
        - `costCenter1` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `costCenter2` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `costCenter3` CostCenterCodeDescriptionDto: A cost center assignment associated with the employee's position.
          - `code` string, nullable: Code identifying the cost center.
          - `description` string, nullable: Full text description of the cost center.
        - `effectiveDate` string, date-time, nullable: Effective date of the cost center assignment.
  - `workLocation` WorkLocationDto
    - `id` string, nullable: Work location identifier.
    - `name` string, nullable: Work location name.
    - `address` WorkLocationAddressDto: Represents the address of a work location.
      - `country` string, nullable: Country where the work location is based.
      - `address1` string, nullable: Address for work location, typically number and street address.
      - `address2` string, nullable: Typically additional identifiers for the work location address, such as suite or floor.
      - `county` string, nullable: County where the work location is based.
      - `city` string, nullable: City where the work location is based.
      - `state` string, nullable: State or province where the work location is based.
      - `zip` string, nullable: Postal code for the work location address.
    - `workPhone` string, nullable: Work phone number.
    - `workPhoneExtension` string, nullable: Work phone extension.
    - `workMobilePhone` string, nullable: Work mobile phone number.
    - `workPager` string, nullable: Work pager number.
    - `workEmail` string, nullable: Work email address.
    - `mailStop` string, nullable: Mail stop code for internal mail routing.
  - `status` StatusDto
    - `records` StatusRecordDto[], nullable: Array of status records for the employee.
      - `recordType` 'past' | 'current' | 'future': Indicates if the record is a past, current, or future record. Allowable Values: past, current, future.
      - `effectiveDate` string, date-time, nullable: Effective date of the employee's status change.
      - `eligibleForRehire` boolean, nullable: Indicates whether the assignment is eligible for rehire.
      - `userAccessEndDate` string, date-time, nullable: Date and time when the employee's system access is scheduled to end.
      - `changeReason` string, nullable: Change reason for the status record.
      - `status` StatusCodeDescriptionDto: The employment status of the employee for a status record (e.g. Active, Leave of Absence).
        - `code` string, nullable: Code identifying the status.
        - `description` string, nullable: Full text description of the status (e.g. Active, Leave of Absence).
      - `statusType` StatusTypeCodeDescriptionDto: The type of employment status record (e.g. Full Time, Part Time).
        - `code` string, nullable: Code identifying the status type.
        - `description` string, nullable: Full text description of the status type (e.g. Full Time, Part Time).
  - `timeLabor` TimeLaborDto
    - `badgeNumber` string, nullable: Employee's clock / badge number.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/paylocity/apis/employee-demographic-api.md) - [All operations](https://skmtc.dev/paylocity/apis/employee-demographic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/employee-demographic-api/revisions/468daf1411c0?raw)