Search safeguards

get

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

Retrieve a list of safeguards (background checks, trainings and similar clearances) matching the given filters. Supply person to return the safeguards recorded for a single person profile.

Required permission: Read Safeguards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

person

int32

≥ 1

Only return safeguards belonging to the given person id.

type

string

Comma-delimited list of safeguard type ids. Values come from /api/property_values/safeguard_types/values.

status

string

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

completed.start

date-time

Return safeguards completed on or after this date.

completed.end

date-time

Return safeguards completed on or before this date.

expires.start

date-time

Return safeguards expiring on or after this date.

expires.end

date-time

Return safeguards expiring on or before this date.

comments

string

Return safeguards whose 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.

200OK