PApaylocity
Employees

(EA) Get Employee [Batch]

🚧 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'))
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

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.

Query parameters

includeTotalCountboolean

When true, returns the total number of matching employees in the X-Pcty-Total-Count response header.

limitinteger

Number of employee records to return per call. Default: 20. Maximum value 20.

offsetinteger

Number of employee records to skip before returning results. Used for pagination.

fieldsstring

Comma-separated list of employee data sections to include in the response. Allowable Values: contact, sensitive, workauthorization, rates, employmentinformation, assignments, position, worklocation, status, timelabor.

filterstring

Narrows which employees are returned in the response. Supported fields: contact.employeeId and employmentInformation.taxForm. Supported operators: eq, ne, in. Example filters: contact.employeeId eq 'A00045678' or employmentInformation.taxForm in ('W2','1099').

Headers

testModeboolean

If true, all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.