Get Screening Orders for Partner
All background check API endpoints are restricted to background check 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
Partners can use this endpoint to retrieve background check (BGC) orders using flexible filters. It supports pulling orders across partner-linked companies, or narrowing by companyID, orderID, candidateID, or date range. Results are always sorted by companyID.
Use Case 1: Partner-wide Order Retrieval
A partner wants a consolidated feed of all BGC orders across every company tied to their API client ID for monitoring and reporting.
Use Case 2: Candidate-Specific Lookup
A partner needs to review all background check orders tied to a single candidate, filtered by their Paylocity candidateID.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.
Headers
Media type(s) the client can accept in the response (typically application/json).
Query parameters
filter like: companyId eq ‘1235’. Filterable fields: companyId, candidateScreeningOrderId, candidate/firstName, candidate/middleName, candidate/lastName
If true it will add X-Pcty-Total-Count header with total count for this specific query.
Pagination offset. Uses item-index offset semantics: this is the number of resources to skip (not a page number). Pair with limit for paging.
Pagination limit. Used together with offset for offset/limit pagination.
Response headers
When the request sets includeTotalCount=true, the API returns this header with the total number of resources available (even if only one page is returned).