Get Assessment packages

get https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages

🚧
Partner Restricted
All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com 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

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/companyId/assessmentPackages?offset=0&limit=20' \
3
     --header 'accept: application/json'


xxxxxxxxxx
35
}
1
{
2
  "count": 0,
3
  "values": [
4
    {
5
      "id": "string",
6
      "status": {
7
        "startDate": "2025-04-06T13:54:14.813Z",
8
        "endDate": "2025-04-06T13:54:14.813Z",
9
        "value": "Active",
10
        "additionalProp": {}
11
      },
12
      "summary": "string",
13
      "name": "string",
14
      "assessments": [
15
        {
16
          "id": "string",
17
          "name": "string",
18
          "summary": "string",
19
          "tests": [
20
            {
21
              "id": "string",
22
              "name": "string",
23
              "category": "string",
24
              "description": "string",
25
              "additionalProp": {}

200Returns partner packages.

400Bad Request - Returns the details of the error.

415Unsupported Media Type - Returns the details of the error.