v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB

Package

Get Assessment Packages

🚧 Partner Restricted All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

This API endpoint is used to retrieve assessment packages configured within Paylocity's platform for a specific companyId.

Use Cases

Retrieve Packages: Fetch a list of all assessment packages available for a specific Paylocity client by using the companyId
Response Details: The API provides a count of packages and detailed information about each one, including IDs, status, summaries, names, and associated assessments and tests

get/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages

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.

Query parameters

offsetinteger

Pagination offset.

limitinteger

Pagination limit, default value is 20.

includeTotalCountboolean

If true, adds X-Pcty-Total-Count header with the total count of results for the query.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns partner packages.

countinteger

Count of items in the Values list.