Search deletion requests

get

https://{tenant}.onechurchsoftware.com/api/people/delete/requests

Retrieve profile deletion requests, pending or completed.

Required permission: Limited Read People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

deleted

boolean

Whether to return completed deletions (true) or pending requests (false). If omitted, both are returned.

name

string

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

string

Return requests whose person's email address (or their family's) contains the given text.

phone

string

Return requests whose person's phone number contains the given digits.

recordType

string

Comma-delimited list of record type ids. Values come from /api/property_values/person_record_type/values.

requestedOn.start

date-time

Return requests made on or after this date.

requestedOn.end

date-time

Return requests made on or before this date.

expiresOn.start

date-time

Return requests expiring on or after this date.

expiresOn.end

date-time

Return requests expiring on or before this date.

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