PApaylocity
Employees

Get Employee [Single]

Summary Description

The GET Employee [Single] endpoint allows clients and partners to retrieve employee demographic data for a single employee record belonging to the companyId. It is ideal for syncing third-party systems with employee information from Paylocity. The endpoint supports several query parameters that allow for more precise control over the data returned:

  • 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)

These parameters make the endpoint highly flexible, enabling clients to tailor requests to their specific integration and business needs.

get/coreHr/v1/companies/{companyId}/employees/{employeeId}

Request

  • Base URL
    https://dc1demogwext.paylocity.com
  • URL
    https://dc1demogwext.paylocity.com/coreHr/v1/companies/{companyId}/employees/{employeeId}
  • Auth
    none declared

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

employeeIdstring required

A filter to use to limit results to a specific employee. Allowable Values: 255 char max

Query parameters

includestring required

Comma separated list of data to be included. Allowable Values: info, position, status, payrate and futurePayrates.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring

Authorization token. Ex. Bearer ...

Response

Success

idstring nullable

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max

companyIdstring nullable

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

relationshipIdstring nullable

The Paylocity Identifier for a group of Company IDs. This is the unique value provided by Paylocity to each specific Payroll Group.

lastNamestring nullable

Last Name.

displayNamestring nullable

Display Name.

statusstring nullable

The Employee Status Description, this value is customizable per client.

statusTypestring nullable

The Employee Status Type Description, this a system controlled value. Allowable Values: A - Active T - Terminated L - Leave

Changes

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