---
title: "Get Assessment Packages"
method: GET
path: "/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages"
tags: ["Package"]
---

# Get Assessment Packages

`GET /apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages`
- Auth: none declared. Required headers: `Authorization`

> 🚧 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](https://www.paylocity.com/contact/partner-form/) 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 parameters

- `companyId` string, required

## Query parameters

- `offset` integer
- `limit` integer
- `includeTotalCount` boolean

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

Returns partner packages.

- PackageDtoListResponse
  - `count` integer: Count of items in the Values list.
  - `values` PackageDto[], nullable: List of items.
    - `id` string, nullable: The unique ID of the package. Required. Max length = 150.
    - `status` StatusDto: Package status payload.
      - `startDate` string, date-time: Start date of package validity. For immediate start use DateTime.UtcNow. Required.
      - `endDate` string, date-time, nullable: End date of package validity. If package doesn’t have expiration date, this field should be null. Optional.
      - `value` 'Active' | 'Inactive' | 'Deleted' | 'Unknown', nullable: Status value. Possible values: “Active, Inactive, Deleted, Unknown”. If value is not provided it will be calculated based on start/end date. Optional.
    - `summary` string, nullable: A summary of the package. Required. Max length = 250.
    - `name` string, nullable: The name of the package. Required. Max length = 250.
    - `assessments` AssessmentDto[], nullable: An array of objects representing the assessments included in the package. Required.
      - `id` string, nullable: The unique ID of the assessment. Required. Max length = 150.
      - `name` string, nullable: The name of the assessment. Required. Max length = 250.
      - `summary` string, nullable: A summary of the assessment. Required. Max length = 250.
      - `tests` AssessmentTestDto[], nullable: An array of objects representing the tests included in the assessment. Required.
        - `id` string, nullable: ID of the test. Required. Max length = 150.
        - `name` string, nullable: Name of the test. Required. Max length = 250.
        - `category` string, nullable: Category of the test. Required. Max length = 50.
        - `description` string, nullable: Description of the test. Required. Max length = 250.

## Other responses

- `400`: Bad Request - Returns the details of the error.
- `401`: Unauthorized
- `415`: Unsupported Media Type - Returns the details of the error.

## Changes

- **2026-11-03** `bf323b2134ff`: 6 info
  - added the optional property `count` to the response with the `400` status
  - added the optional property `count` to the response with the `401` status
  - added the optional property `count` to the response with the `415` status
  - added the optional property `value` to the response with the `400` status
  - …2 more

[Operation history](https://skmtc.dev/paylocity/apis/assessments-api/changes/apiHub/performanceManagement/v1/companies/:companyId/assessmentPackages/get.md)

---

[API](https://skmtc.dev/paylocity/apis/assessments-api.md) - [All operations](https://skmtc.dev/paylocity/apis/assessments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/assessments-api/revisions/bf323b2134ff?raw)