Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Order

Get partner assessment orders

🚧 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 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.

get/apiHub/performanceManagement/v1/companies/b6001/partner/assessmentOrders

Query parameters

filterstring

String to filter results, e.g., '?filter=assessmentorderid eq 'assessment_order_id''.

includeTotalCountboolean

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

offsetinteger

Pagination offset for the result set.

limitinteger

Maximum number of results to return in a single call.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns the detailed list of assessment orders.

companyIdstring nullable

CompanyId of the order.

assessmentOrderIdstring nullable

Unique identifier of the assessment order.

packageIdstring nullable

Unique identifier of the package associated with the order.

packageNamestring nullable

Name of the package associated with the order.

jobIdstring nullable

The ID of the job that the assessee is applying to.

jobTitlestring nullable

The title of the job that the assessee is applying to.

locationstring nullable

The location.

status'InProgress' | 'ActionsNeeded' | 'Completed'

Order status.

overallScorestring nullable

Order overall score.

overallScoreDescriptionstring nullable

Order overall score description.

billingCodestring nullable

Billing code associated with the order.

assessmentOrderSource'Recruitment' | 'HR' | 'RecruitmentEngine' nullable

Order source.

createdAtstring date-time nullable

Date time of the order creation.

updatedAtstring date-time nullable

Date time of the latest order update.

All 81 operations