Get Employees [Batch]
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.
Request
- Base URLhttps://dc1demogwext.paylocity.com
- URLhttps://dc1demogwext.paylocity.com/coreHr/v1/companies/{companyId}/employees
- Authnone declared
Path parameters
The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max
Query parameters
Number of employees per page. Default Value: 20 Maximum Value: 20
Next token for the page.
Comma separated list of data to be included. Allowable Values: info, position, status, payrate and futurePayrates.
Filter only active employees. Allowable Values: true, false
Headers
If true all responses are mocked and generated randomly.
Authorization token. Ex. Bearer ...
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.