--- title: "Get Employees [Batch]" method: GET path: "/coreHr/v1/companies/{companyId}/employees" tags: ["Employees"] --- # Get Employees \[Batch\] `GET /coreHr/v1/companies/{companyId}/employees` ## Request - Base URL: `https://dc1demogwext.paylocity.com` - URL: `https://dc1demogwext.paylocity.com/coreHr/v1/companies/{companyId}/employees` - Auth: none declared **Summary Description** The **GET Employee [Batch]** endpoint allows clients and partners to retrieve employee demographic data in batches of up to 20 records per call. 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, with a maximum of 20 - **nextToken** – Next Token for the page - **include** – Allows selective retrieval of additional data elements related to the employee, such as: - **info** (basic demographic details) - **position** (job and department data) - **status** (employment status) - **payRate**(current compensation details) - **futurePayRate** (scheduled future pay rate changes) - **activeOnly** – When set to true, limits the response to employees whose Employee Status Type is 'Active' These parameters make the endpoint highly flexible, enabling clients to tailor requests to their specific integration and business needs. ## Path parameters - `companyId` string, required ## Query parameters - `limit` integer - `nextToken` string - `include` string - `activeOnly` boolean ## Headers - `testMode` boolean - `Authorization` string ## Response `200` Success - EmployeePage - `totalCount` integer: Total number of employee records available for the given company. - `employees` Employee[], nullable: List of employee records returned for the current page. - `id` string, nullable: The Paylocity Employee ID. This is a unique value per Paylocity Company ID. **Allowable Values:** 10 char max - `companyId` string, nullable: The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. - `relationshipId` string, nullable: The Paylocity Identifier for a group of Company IDs. This is the unique value provided by Paylocity to each specific Payroll Group. - `lastName` string, nullable: Last Name. - `displayName` string, nullable: Display Name. - `status` string, nullable: The Employee Status Description, this value is customizable per client. - `statusType` string, nullable: The Employee Status Type Description, this a system controlled value. **Allowable Values:** A - Active T - Terminated L - Leave - `currentStatus` CurrentEmployeeStatus - `status` string, nullable: The employee status description. - `statusCode` string, nullable: The employee status code. - `statusType` string, nullable: The employee status type code. **Allowable Values:** A - Active T - Terminated L - Leave - `effectiveDate` string, date-time, nullable: Effective date of the latest employee status change. - `changeReason` string, nullable: Change reason description of the latest employee status change. - `changeReasonCode` integer, nullable: Change reason code for the latest employee status change. - `info` EmployeeInfo - `firstName` string, nullable: First Name. - `lastName` string, nullable: Last Name. - `displayName` string, nullable: Display Name. - `middleName` string, nullable: Middle Name. - `preferredName` string, nullable: Preferred Name. - `suffix` string, nullable: Suffix. - `address` Address - `address1` string, nullable: Address1 - `address2` string, nullable: Address2 - `city` string, nullable: City - `state` string, nullable: State - `postalCode` string, nullable: PostalCode - `country` string, nullable: Country - `county` string, nullable: County - `homePhone` string, nullable: Home Phone Number. - `mobilePhone` string, nullable: Mobile Phone Number. - `personalEmail` string, nullable: Personal Email. - `ssn` string, nullable: Social Security Number. **Allowable Values:** 11 char max - `dateOfBirth` string, nullable: Date of Birth. **Allowable Values:** Format: MM/DD/CCYY - `maritalStatus` string, nullable: Marital Status. **Allowable Values:** 10 char max - `ethnicityRace` string, nullable: Ethnicity. **Allowable Values:** 10 char max - `gender` string, nullable: Gender. **Allowable Values:** 1 char max - `hireDate` string, date-time, nullable: Hire Date. **Allowable Values:** Format: MM/DD/CCYY - `adjustedSeniorityDate` string, date-time, nullable: Adjusted Seniority Date. **Allowable Values:** Format: MM/DD/CCYY - `eligibleforRehire` boolean, nullable: Eligible for Rehire Flag. - `supervisorCo` string, nullable: Supervisor Paylocity Company ID. - `supervisor` string, nullable: Supervisor. - `isSupervisor` boolean, nullable: Is Supervisor / Reviewer? Flag. - `reviewerCo` string, nullable: Reviewer Paylocity Company ID. - `reviewer` string, nullable: Reviewer Employee ID. - `jobTitle` string, nullable: Job Title. - `eeoClass` string, nullable: EEO Class. - `wcc` string, nullable: Workers Compensation Code. - `shift` string, nullable: Home Shift. - `clockBadge` string, nullable: Clock / Badge Number. - `payGroup` string, nullable: Pay Group. - `otExempt` boolean, nullable: OT Exempt (Y/N). - `tipped` string, nullable: Tipped. - `minWageExempt` boolean, nullable: Minimum Wage Exempt. - `workLocation` WorkLocation - `address` Address - `address1` string, nullable: Address1 - `address2` string, nullable: Address2 - `city` string, nullable: City - `state` string, nullable: State - `postalCode` string, nullable: PostalCode - `country` string, nullable: Country - `county` string, nullable: County - `phone` string, nullable: Phone. - `phoneExt` string, nullable: Phone Extension - `mobilePhone` string, nullable: Work Mobile Phone - `email` string, nullable: Work Email Address. - `currentPayRate` CurrentPayRate - `baseRate` number, double, nullable: Employee Base Pay Rate. - `defaultHours` number, double, nullable: Default Hours for the Employee in the Pay Period. - `salary` number, double, nullable: Per Check Salary Rate. - `payFrequency` string, nullable: Pay Frequency. - `payGrade` string, nullable: Pay Grade. - `annualSalary` number, double, nullable: Annual Salary. - `ratePer` string, nullable: Rate Per. - `effectiveDate` string, date-time, nullable: Effective date of the last employee rate change. - `beginCheckDate` string, nullable: Begin Check date of the last employee rate change. - `isAutoPay` boolean, nullable: Auto Pay Employee Flag. - `payType` string, nullable: Hourly or Salary Pay Type - `position` Position - `effectiveDate` string, date-time, nullable: Effective date of the last employee position change. - `changeReason` string, nullable: Change Reason of last Position Change. - `costCenter1` string, nullable: Cost Center 1 Code. - `costCenter2` string, nullable: Cost Center 2 Code. - `costCenter3` string, nullable: Cost Center 3 Code. - `employeeType` string, nullable: Employee Type. - `positionCode` string, nullable: Position Code. - `positionDescription` string, nullable: Position Description. - `careerLevelCode` string, nullable: Career level code. - `careerLevelDescription` string, nullable: Career level description. - `positionFamilies` PositionFamily[], nullable: Position families. - `code` string, nullable: Position family code. - `description` string, nullable: Position family description. - `name` string, nullable: Position family name. - `futurePayRates` PayRate[], nullable: Future pay rates. - `salary` number, double, nullable: Per Check Salary Rate. - `payFrequency` string, nullable: Pay Frequency. - `changeReason` string, nullable: Change reason. - `annualSalary` number, double, nullable: Annual Salary. - `effectiveDate` string, date-time, nullable: Effective date of the last employee rate change. - `beginCheckDate` string, nullable: Begin Check date of the last employee rate change. - `isAutoPay` boolean, nullable: Auto Pay Employee Flag. - `payType` string, nullable: Hourly or Salary Pay Type. - `payRateDescription` string, nullable: Pay rate description. --- [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)