Search soft credits

Retrieve soft credits matching the given filters. A caller limited to merchants or giving portals sees only credits on contributions within those limits. While multi-campus is on, a campus-limited caller sees the credits whose contribution is placed at one of their campuses (the campuses of its designations), or is organization-wide in an organization they reach, and the credits on their own giving, narrowed by the selected campus lens. The donor's and the credited person's campuses do not count. A caller with campus permission overrides, or with a campus limit and people read, sees a credited person they cannot read in full with only the email and phone that person shares with the organization, and may not filter or sort by email or phone (403). A credit on a gift in an open batch also needs Full Read Contributions or Limited Write Contributions, unless the gift is the caller's own; without Unrestricted Batches or Full Read Contributions, the caller sees only credits on their own gifts and on gifts in their own open batches.

Required permission: Limited Read Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
≥ 1

The id of the person who received the soft credit.

string

Organization ids, comma-separated; honoured while money splits by organization (multi-org is on, or an archived organization still owns money). A soft credit matches when its contribution belongs to one of them (the organization the contribution is stamped with). An archived organization's id counts only when it still owns gifts or batches and the caller reads its whole giving (the profile giving overview's links); otherwise it is dropped.

date-time

Return soft credits whose contribution was given on or after this date (a calendar date; an instant is read in the church's time zone).

date-time

Return soft credits whose contribution was given on or before this date (a calendar date; an instant is read in the church's time zone).

string

Return soft credits whose recipient's email address contains the given text. Refused (403) for a caller with campus permission overrides, or with a campus limit and people read.

string

Return soft credits whose recipient's phone number contains the given digits. Refused (403) for a caller with campus permission overrides, or with a campus limit and people read.

int32
≥ 1

The id of the person or business credited with the underlying contribution.

double

Return soft credits of at least this amount.

double

Return soft credits of at most this amount.

string

Comma-delimited list of designation ids. Returns soft credits whose contribution gave to any of them. Values come from /api/designations.

int32
≥ 0

The number of records to skip before returning results, used for paging.

int32
≥ 0

The maximum number of records to return per page. Defaults to 50.

string

The field to sort the results by. The default field depends on the endpoint.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json