Search designations

get

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

Retrieve a list of contribution designations matching the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include designations which contain this text in the name.

code

string

Include designations which contain this text in the abbreviation.

description

string

Include designations which contain this text in the description.

category

string

Comma-delimited list of category ids. Use -1 to include designations without a category. Values come from /api/property_values/fund_category/values.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include designations with no campus. Values come from /api/locations.

funds

string

Comma-delimited list of designation ids to restrict the results to.

portal

string

Comma-delimited list of giving portal ids. Use -1 to include designations not available on any giving portal.

deductible

boolean

Whether contributions to the designation are tax deductible or not.

active

boolean

Whether the designation is active or not. When filtering for inactive designations, also set all to true.

all

boolean

Include inactive designations. By default only active designations are returned.

summary

boolean

Include giving statistics, text-giving keywords, and accounting posting details in the results. Requires the Financial Settings permission; ignored otherwise.

keywordsOnly

boolean

Only include designations with text-giving keywords. Giving statistics reflect text giving only.

amount.start

double

Only include designations whose total giving is at least this amount.

amount.end

double

Only include designations whose total giving is at most this amount.

transactions.start

double

Only include designations with at least this many transactions.

transactions.end

double

Only include designations with at most this many transactions.

schedules.start

double

Only include designations with at least this many recurring giving schedules.

schedules.end

double

Only include designations with at most this many recurring giving schedules.

latest.start

date-time

Only include designations that last received a gift on or after this date.

latest.end

date-time

Only include designations that last received a gift on or before this date.

filter

string

Free text search across the designation's name, abbreviation, category, and description.

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

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