GuidesRecipesAPI ReferenceChangelog
Login
API Reference
Login

Get Assessment Packages

get
https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies//assessmentPackages
🚧

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
Path Params
string
required

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

Query Params
int32
Defaults to 0

Pagination offset.

int32
Defaults to 20

Pagination limit, default value is 20.

boolean
Defaults to false

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

Headers
boolean

If true all responses are mocked and generated randomly.

string
required

Authorization token. Ex. Bearer ...

Responses

Updated 26 days ago

Did this page help you?
Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 26 days ago

Did this page help you?