---
title: "Get Screening Orders for Partner"
method: GET
path: "/compliance/v1/companies/b6001/partner/backgroundCheckOrders"
tags: ["Candidate Screening Order"]
---

# Get Screening Orders for Partner

`GET /compliance/v1/companies/b6001/partner/backgroundCheckOrders`

> 🚧 Partner Restricted
> All background check API endpoints are restricted to background check 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**

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.

## Query parameters

- `filter` string
- `includeTotalCount` boolean
- `offset` integer
- `limit` integer

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

Returns list of the screening order

- PartnerGetCandidateScreeningOrderDto[]
  - `candidateScreeningOrderId` string, uuid — Unique identifier for the candidate screening order.
  - `candidate` CandidateExternalDto
    - `title` string, nullable — Holds the title of the candidate, e.g., Mr., Ms., Dr.
    - `firstName` string, nullable — Candidate's first name.
    - `middleName` string, nullable — Candidate's middle name.
    - `lastName` string, nullable — Candidate's last name.
    - `email` string, nullable — Candidate's email address.
    - `mobile` string, nullable — Candidate's mobile phone number.
    - `location` string, nullable — Location of the candidate.
    - `address` string, nullable — Address of the candidate.
    - `country` string, nullable — Country of the candidate.
    - `city` string, nullable — City of the candidate.
    - `province` string, nullable — Province of the candidate.
  - `companyId` string, nullable — Identifier for the company associated with the screening.
  - `packageId` string, nullable — Identifier for the screening package selected.
  - `billingCode` string, nullable — Billing code associated with the screening order.
  - `location` string, nullable — Location associated with the screening order.
  - `recruiter` RecruiterDto
    - `recruiterId` string, nullable — Unique identifier for the recruiter.
    - `firstName` string, nullable — First name of the recruiter.
    - `lastName` string, nullable — Last name of the recruiter.
    - `email` string, nullable — Email address of the recruiter.
    - `certificationDateTime` string, date-time — The date and time when the recruiter was certified. Date format in ISO 8601.
  - `workAddress` string, nullable — WorkAddress associated with the screening order.
  - `workCity` string, nullable — WorkCity associated with the screening order.
  - `workCountry` string, nullable — WorkCountry associated with the screening order.
  - `workProvince` string, nullable — WorkProvince associated with the screening order.
  - `jobData` PartnerJobDataDto — Job data associated with the screening order.
    - `jobTitle` string, nullable — The position name that identifies the individual’s role in the company. Optional.
    - `positionCode` string, nullable — A unique code or identifier that represents the individual’s position or job role within an organization. Optional.
    - `costCenter1Name` string, nullable — The name or title of the cost center, offering a clear and descriptive label for easy recognition and understanding of its role and responsibilities. Optional.
    - `costCenter2Name` string, nullable — The name or title of the cost center, offering a clear and descriptive label for easy recognition and understanding of its role and responsibilities. Optional.
    - `costCenter3Name` string, nullable — The name or title of the cost center, offering a clear and descriptive label for easy recognition and understanding of its role and responsibilities. Optional.
    - `costCenter1Code` string, nullable — A code or label representing the cost center, aiding in its categorization and differentiation within the organization's financial and operational framework. Optional.
    - `costCenter2Code` string, nullable — A code or label representing the cost center, aiding in its categorization and differentiation within the organization's financial and operational framework. Optional.
    - `costCenter3Code` string, nullable — A code or label representing the cost center, aiding in its categorization and differentiation within the organization's financial and operational framework. Optional.
  - `businessUnitId` string, nullable — Business Unit ID associated with the screening order. Optional.
  - `services` PctyModuleServiceDto[], nullable — Candidate screening order services.
    - `serviceName` string, nullable
    - `status` string, nullable
    - `note` string, nullable
  - `status` 'Ordered' | 'WaitingOnCandidate' | 'InProgress' | 'Hold' | 'Complete' | 'CompleteWithCancelled' | 'Cancelled' | 'CompleteNeedsReview' | 'CompleteNotEligible' | 'Suspended' | 'Resumed' | 'CompleteDisputed' | 'InvitationExpired' | 'InvitationCancelled' | 'PreAdverseActionSent' | 'AdverseActionCancelled' | 'Dispute' | 'AdverseActionSent' — Screening order status.
  - `createdAt` string, date-time — Date of when the screening order was created.
  - `updatedAt` string, date-time — Date of when the screening order was updated.
  - `note` string, nullable — This is an optional field that can contain additional details.

## Other responses

- `400` — Bad Request Error - Returns the details of the error
- `401` — Unauthorized
- `404` — Not Found
- `415` — Unsupported Media Type - Returns the details of the error

---

[API](https://skmtc.net/paylocity/apis/assessments-api.md) · [All operations](https://skmtc.net/paylocity/apis/assessments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paylocity/assessments-api/revisions/dd22ab229153/schema)