PApaylocity
Pay Schedules

Get Employees by Pay Period

🚧 Partner Restricted

This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

Summary Description

Retrieves all employee Ids associated with a specific Pay period.

get/apiHub/payroll/v1/companies/{companyId}/payPeriods/{payPeriodId}/employees

Request

  • Base URL
    https://dc1demogwext.paylocity.com
  • URL
    https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/payPeriods/{payPeriodId}/employees
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

The Paylocity Company Identifier.

payPeriodIdstring required

The unique identifier of the pay period.

Query parameters

limitinteger

Maximum number of records to return.

nextTokenstring

Token returned from a previous response to retrieve the next page.

Headers

testModeboolean

If true, responses are mocked.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

employeeIdsstring[] nullable

The list of employee IDs assigned to the pay period.

Changes

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