List campaigns
curl --request GET \
--url https://{organization}.rescueconsole.com/api/fundraising/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/fundraising/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/fundraising/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"goal_amount_cents": 1,
"status": "draft",
"id": "<string>",
"total_raised_cents": 123,
"donation_count": 123,
"donor_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"metadata": {},
"custom_fields": {},
"tenant_id": "<string>",
"progress_percent": 123
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Campaigns
List campaigns
One page of your campaigns, newest first. Each carries what it has raised from completed gifts. This list does not return a total; use the campaign counts for that. Needs read on Fundraising.
GET
/
api
/
fundraising
/
campaigns
List campaigns
curl --request GET \
--url https://{organization}.rescueconsole.com/api/fundraising/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/fundraising/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/fundraising/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"goal_amount_cents": 1,
"status": "draft",
"id": "<string>",
"total_raised_cents": 123,
"donation_count": 123,
"donor_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"metadata": {},
"custom_fields": {},
"tenant_id": "<string>",
"progress_percent": 123
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
Only campaigns with this status.
Available options:
draft, active, paused, completed, archived How many to return. 25 unless you say, 100 at most.
Required range:
1 <= x <= 100How many to skip, for the next page.
Required range:
x >= 0