Get All Employees

Get All Employees API will return employee data currently available in Paylocity Payroll/HR solution.

get/v2/companies/{companyId}/employees

Request

Base URL
https://dc1demogw.paylocity.com/api
URL
https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/employees
Auth
OAuth 2
Client credentials
Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

companyIdstring required

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

pagesizeinteger

Number of records per page. Default value is 25.

pagenumberinteger

Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.

includetotalcountboolean

Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.

Successfully Retrieved

employeeIdstring

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

statusCodestring

Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20

statusTypeCodestring

Employee current work status type. <br />Max length: 10

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