Search pledges

get

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

Retrieve a list of pledges matching the given filters.

Required permission: Full Read Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

person

int32

The id of the person the pledges belong to. Includes household pledges the person is covered by.

campaign

string

Comma-delimited list of giving campaign ids.

frequency

string

Comma-delimited list of pledge frequency ids (1 = Weekly, 2 = Bi-Weekly, 3 = Semi-Monthly, 4 = Monthly, 5 = Quarterly, 6 = Semi-Annually, 7 = Annually, 8 = One Time, 9 = Bi-Monthly).

active

boolean

Whether the pledge is currently active, i.e. its end date is in the future.

name

string

Text matched against the pledger's name and aliases. When multiple words are given, every word must match.

start.start

date-time

Return pledges starting on or after this date.

start.end

date-time

Return pledges starting on or before this date.

end.start

date-time

Return pledges ending on or after this date.

end.end

date-time

Return pledges ending on or before this date.

string

Return pledges whose pledger's email address contains the given text.

phone

string

Return pledges whose pledger's phone number contains the given digits.

total.start

double

Return pledges totaling at least this amount.

total.end

double

Return pledges totaling at most this amount.

occurrences.start

double

Return pledges with at least this many occurrences.

occurrences.end

double

Return pledges with at most this many occurrences.

amount.start

double

Return pledges of at least this amount per interval.

amount.end

double

Return pledges of at most this amount per interval.

additional.start

double

Return pledges with an additional amount of at least this value.

additional.end

double

Return pledges with an additional amount of at most this value.

paid.start

double

Return pledges with at least this amount paid.

paid.end

double

Return pledges with at most this amount paid.

remaining.start

double

Return pledges with at least this amount remaining.

remaining.end

double

Return pledges with at most this amount remaining.

percentage.start

double

Return pledges at least this percent complete (0-100).

percentage.end

double

Return pledges at most this percent complete (0-100).

createdBy

string

Return pledges created by the given user name.

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