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 [email protected] 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 Params
string

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

boolean

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

int32
Defaults to 0

Pagination offset for the result set.

int32
Defaults to 20

Maximum number of results to return in a single call.

Headers
boolean

If true all responses are mocked and generated randomly.

string
required

Authorization token. Ex. Bearer ...

Responses

Language
Response
Choose an example:
application/json