Search background checks

get

https://{tenant}.onechurchsoftware.com/api/backgroundchecks

Retrieve background checks matching the given filters. Requires permission to view background checks.

Required permission: Read Background Checks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

Comma-delimited list of status ids. Values come from /api/property_values/bcheck_statuses/values.

archived

boolean

Whether to return archived or unarchived background checks.

position

string

Comma-delimited list of applicant position ids. Use -1 to include checks without a position. Values come from /api/property_values/bcheck_applicant/values.

report

string

Comma-delimited list of report ids. Returns checks that include one of those reports. Values come from /api/property_values/bcheck_reports/values.

package

string

Comma-delimited list of screening package ids: 1 = Basic, 2 = Plus, 3 = PA 153 Package, 4 = Customized, 5 = Auto County 7 yrs w/Smart Search.

name

string

Text matched against the first, middle and last name as submitted on the check. When multiple words are given, every word must match.

string

Return checks whose email address contains the given text.

phone

string

Return checks whose phone number contains the given digits.

decision

boolean

Whether the check is ready for a decision.

address.street

string

The street address.

address.city

string

The city.

address.state

string

The state or province.

address.postalCode

string

The postal code.

campus

string

Comma-delimited list of campus ids. Use -1 to include checks without a campus. Values come from /api/locations.

submitted.start

date-time

Return checks submitted on or after this date.

submitted.end

date-time

Return checks submitted on or before this date.

ipAddress

string

Return checks requested from an IP address containing the given text.

comments

string

Return checks whose linked safeguard's comments contain the given text.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK