Search soft credits

get

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

Retrieve soft credits matching the given filters.

Required permission: Limited Read Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

person

int32

≥ 1

The id of the person who received the soft credit.

date.start

date-time

Return soft credits whose contribution was given on or after this date and time.

date.end

date-time

Return soft credits whose contribution was given on or before this date and time.

string

Return soft credits whose recipient's email address contains the given text.

phone

string

Return soft credits whose recipient's phone number contains the given digits.

payee

int32

≥ 1

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

amount.start

double

Return soft credits of at least this amount.

amount.end

double

Return soft credits of at most this amount.

designation

string

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

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.

200OK