Search giving schedules

get

https://{tenant}.onechurchsoftware.com/api/contributions/schedules

Retrieve recurring giving schedules matching the given filters.

Required permission: Full Read Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

active

boolean

Whether to return currently active schedules (true) or inactive ones (false).

amount.start

double

Return schedules whose gift amount (excluding covered fees) is at least this value.

amount.end

double

Return schedules whose gift amount (excluding covered fees) is at most this value.

designation

string

Comma-delimited list of designation ids. Returns schedules giving to any of them. Values come from /api/designations.

business

boolean

Whether to return schedules created for businesses (true) or for people (false).

personCampus

string

Comma-delimited list of campus (location) ids the donor belongs to. Use -1 to include people with no campus.

name

string

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

string

Return schedules whose donor's email address contains the given text.

phone

string

Return schedules whose donor's phone number contains the given digits.

person

int32

≥ 1

The id of the person the schedules belong to.

type

string

Comma-delimited list of payment types. Accepted values: card, ach.

frequency

string

Comma-delimited list of 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.

nextTransaction.start

date-time

Return schedules whose next charge date is on or after this date.

nextTransaction.end

date-time

Return schedules whose next charge date is on or before this date.

created.start

date-time

Return schedules created on or after this date.

created.end

date-time

Return schedules created on or before this date.

processed.start

double

Return schedules whose total processed amount is at least this value.

processed.end

double

Return schedules whose total processed amount is at most this value.

transactions.start

double

Return schedules that have processed at least this many contributions.

transactions.end

double

Return schedules that have processed at most this many contributions.

merchant

string

Comma-delimited list of merchant account ids. Use -1 to include schedules with no merchant account.

givingPortal

string

Comma-delimited list of giving portal ids. Use -1 to include schedules not created through a giving portal.

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