Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/
https://fundraising.api.rhythmsoftware.com/

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Migrate Donation Orders

Request

Will migrate all previous orders for donation products

Path
tenantIdstringrequired

The id of the tenant being accessed

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/migrateDonationOrders' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Conflicts were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

Returns a list of records with the specified order_id

Request

Returns a list of records with the specified order_id

Path
tenantIdstringrequired

The tenant

order_idstringrequired

The order_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/order/{order_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Gift)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Returns a list of records with the specified organization_id

Request

Returns a list of records with the specified organization_id

Path
tenantIdstringrequired

The tenant

organization_idstringrequired

The organization_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/gifts/{tenantId}/organization/{organization_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Gift)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Giving Processes

Giving Processes

Operations

Pledge Levels

Pledge Levels

Operations

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations