Pay Schedules

Get Pay Schedules by companyID

🚧 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 pay schedules for the specified company.

get/apiHub/payroll/v1/companies/{companyId}/paySchedules

Request

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

Path parameters

companyIdstring required

The Paylocity Company Identifier.

Query parameters

startDatestring

Required start date (yyyy-MM-dd).

endDatestring

Required end date (yyyy-MM-dd).

includeTotalCountboolean

When true, includes the total count in the response headers.

limitinteger

Maximum number of records to return.

offsetinteger

Number of records to skip before returning results.

Headers

testModeboolean

If true, responses are mocked.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

Changes

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