Search giving campaigns

get

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

Retrieve a list of giving campaigns (fundraisers where donors pledge toward a goal amount) matching the given filters.

Required permission: Full Read Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Text matched against the campaign's name.

description

string

Text matched against the campaign's description.

designation

string

Comma-delimited list of designation ids; returns campaigns that apply giving to any of them.

start.start

date-time

Return campaigns starting on or after this date.

start.end

date-time

Return campaigns starting on or before this date.

end.start

date-time

Return campaigns ending on or after this date.

end.end

date-time

Return campaigns ending on or before this date.

pledgesOnly

boolean

Whether only giving toward pledges counts for the campaign.

early

boolean

Whether the campaign allows giving before its start date.

active

boolean

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

createdBy

string

Return campaigns created by the given user name (exact match).

pledges.start

double

Return campaigns with at least this many pledges.

pledges.end

double

Return campaigns with at most this many pledges.

goal.start

double

Return campaigns with a goal of at least this amount.

goal.end

double

Return campaigns with a goal of at most this amount.

pledged.start

double

Return campaigns with at least this amount pledged.

pledged.end

double

Return campaigns with at most this amount pledged.

paid.start

double

Return campaigns that raised at least this amount.

paid.end

double

Return campaigns that raised at most this amount.

remaining.start

double

Return campaigns with at least this amount remaining.

remaining.end

double

Return campaigns with at most this amount remaining.

percentage.start

double

Return campaigns at least this percent of the way to their goal (0-100).

percentage.end

double

Return campaigns at most this percent of the way to their goal (0-100).

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