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