--- title: "Get partner assessment orders" method: GET path: "/apiHub/performanceManagement/v1/companies/b6001/partner/assessmentOrders" tags: ["Order"] --- # Get partner assessment orders `GET /apiHub/performanceManagement/v1/companies/b6001/partner/assessmentOrders` ## Request - Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known) - URL: `dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/b6001/partner/assessmentOrders` - 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 endpoint allows partners retrieve assessment orders for companies actively onboarded to their API client ID. Orders can be filtered by company ID, order ID, candidate ID, or creation date, and are always sorted by companyId. **Use Case** A partner support team needs to troubleshoot a client issue. They use the endpoint to pull all assessment orders for a company and quickly identify discrepancies or status of the order in Paylocity. ## Query parameters - `filter` string - `includeTotalCount` boolean - `offset` integer - `limit` integer ## Headers - `testMode` boolean - `Authorization` string, required ## Response `200` Returns the detailed list of assessment orders. - ExternalPartnerAssessmentOrderResponse[] - `companyId` string, nullable: CompanyId of the order. - `assessmentOrderId` string, nullable: Unique identifier of the assessment order. - `packageId` string, nullable: Unique identifier of the package associated with the order. - `packageName` string, nullable: Name of the package associated with the order. - `jobId` string, nullable: The ID of the job that the assessee is applying to. - `jobTitle` string, nullable: The title of the job that the assessee is applying to. - `location` string, nullable: The location. - `status` 'InProgress' | 'ActionsNeeded' | 'Completed': Order status. - `overallScore` string, nullable: Order overall score. - `overallScoreDescription` string, nullable: Order overall score description. - `billingCode` string, nullable: Billing code associated with the order. - `reports` ReportPayload[], nullable: Overall reports of the assessment order. - `name` string, nullable: The name of the report. Max length = 250. Optional. - `url` string, nullable: The URL of the report that can be viewed on the partners web application. Max length = 2048. Required. - `updatedAt` string, date-time: The date and time when the report was last updated. - `requester` RequesterDto: Represents the requester of an assessment. - `id` string, nullable: The unique identifier of the requester. Optional. Max length = 150. - `firstName` string, nullable: The first name of the requester. Optional. Max length = 40. - `lastName` string, nullable: The last name of the requester. Optional. Max length = 40. - `email` string, nullable: The email address of the requester. Optional. Max length = 50. - `assessee` AssesseeDto: Represents the assessee being assessed. - `id` string, nullable: The unique identifier of the assessee. Required. Max length = 150. - `title` string, nullable: The assessee's title. Optional. Max length = 50. - `firstName` string, nullable: The first name of the assessee. Required. Max length = 40. - `middleName` string, nullable: The middle name of the assessee. Required. Max length = 40. - `lastName` string, nullable: The last name of the assessee. Required. Max length = 40. - `email` string, nullable: The email address of the assessee. Required. Max length = 50. - `mobile` string, nullable: The mobile number of the assessee. Required. Max length = 25. - `location` string, nullable: The location of the assessee. Required. Max length = 250. - `assessments` AssessmentResultDto[], nullable: List of assessments. Required. - `assessmentId` string, nullable: Unique identifier of the assessment. - `assessmentName` string, nullable: Name of the assessment. - `assessmentStatus` AssessmentStatusDto: Assessment order status payload. - `updatedAt` string, date-time: The date and time when the assessment order was updated. Required. - `value` 'Ordered' | 'WaitingOnAssessee' | 'InProgress' | 'Hold' | 'Complete' | 'CompleteReview' | 'RetestRecommended' | 'Expired', nullable: The new status of the assessment order. Required. - `assessmentResults` InternalAssessmentResultsDto: The object of the results for an assessment. - `score` string, nullable: An indication of if the assessee met all necessary predetermined ranges set for the job. Max length = 30. - `scoreDescription` string, nullable: Description of the overall score. Max length = 250. - `progress` string, nullable: Current Assessment progress. Calculated by number of completed tests / assigned tests. - `reports` ReportPayload[], nullable: Overall reports of the assessment. - `name` string, nullable: The name of the report. Max length = 250. Optional. - `url` string, nullable: The URL of the report that can be viewed on the partners web application. Max length = 2048. Required. - `updatedAt` string, date-time: The date and time when the report was last updated. - `tests` InternalTestDto[], nullable: Assessment order tests. - `name` string, nullable: Assessment test name. - `id` string, nullable: Assessment order test id. Max length = 150. Required. - `score` ScorePayload: Score payload. - `value` string, nullable: The value of the score. Max length = 50. Optional. - `description` string, nullable: The description of the score. This is an optional field where you can add description of what the score means for the assessee relative to the job posting. Max length = 250. Optional. - `attempt` integer: The attempt of the test. Required. - `reports` ReportPayload[], nullable: Score reports. Optional. - `name` string, nullable: The name of the report. Max length = 250. Optional. - `url` string, nullable: The URL of the report that can be viewed on the partners web application. Max length = 2048. Required. - `updatedAt` string, date-time: The date and time when the report was last updated. - `testStatus` TestStatusDto: Assessment order test status payload. - `updatedAt` string, date-time: The date and time when the assessment test was updated. Required. - `value` 'Ordered' | 'Pending' | 'InProgress' | 'Hold' | 'Complete' | 'RetestRecommended' | 'Expired', nullable: The new status of the assessment test. Required. - `assessmentOrderSource` 'Recruitment' | 'HR' | 'RecruitmentEngine', nullable: Order source. - `createdAt` string, date-time, nullable: Date time of the order creation. - `updatedAt` string, date-time, nullable: Date time of the latest order update. ## Other responses - `400`: Bad Request - Provides details on the error if the request is not properly formatted. - `401`: Unauthorized - `404`: Not Found - Returns details if no orders are found with the given criteria. - `415`: Unsupported Media Type - Returns the details of the error. ## Changes - **2026-11-03** `bf323b2134ff`: 8 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 `404` status - added the optional property `count` to the response with the `415` status - …4 more [Operation history](https://skmtc.dev/paylocity/apis/assessments-api/changes/apiHub/performanceManagement/v1/companies/b6001/partner/assessmentOrders/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)