Search child safety trainings

get

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

Retrieve child safety trainings 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

type

string

Comma-delimited list of training product ids: 3 = Volunteer, 79 = Employee (English), 83 = Employee (Spanish).

status

string

Comma-delimited list of status ids (or status names). Values come from /api/property_values/cst_status/values.

completed.start

date-time

Return trainings completed on or after this date.

completed.end

date-time

Return trainings completed on or before this date.

expired.start

date-time

Return trainings expiring on or after this date.

expired.end

date-time

Return trainings expiring on or before this date.

submitted.start

date-time

Return trainings requested on or after this date.

submitted.end

date-time

Return trainings requested on or before this date.

score.start

double

Return trainings with a score of at least this value.

score.end

double

Return trainings with a score of at most this value.

passed

boolean

Whether the person passed the training.

person

int32

≥ 1

The id of a person. Returns only that person's trainings.

name

string

Text matched against the person's first, middle and last name. When multiple words are given, every word must match.

string

Return trainings for people whose email address contains the given text.

phone

string

Return trainings for people whose phone number contains the given digits.

campus

string

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

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