curl --request GET \
--url https://{organization}.rescueconsole.com/api/fundraising/campaigns/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/fundraising/campaigns/{id}', 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/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
}{
"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)"
}Get one campaign
The campaign, with what it has raised from completed gifts. Needs read on Fundraising.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/fundraising/campaigns/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/fundraising/campaigns/{id}', 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/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
}{
"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_.
Path Parameters
The campaign's ID.
Response
The campaign.
Cannot be blank.
The goal, in whole cents: 1500000 is $15,000.00. 0 means no goal.
x >= 0draft, active, paused, completed, archived The sum of the completed gifts given to this campaign, in whole cents.
How many completed gifts.
How many different people gave them.
A short name for the campaign's address. No two of your campaigns may share one.
Anything else you want to keep with the campaign, as keys and values.
Values for your own campaign fields, by field key. A key that is not one of your fields is refused.
Your organization's ID.
What has been raised as a percentage of the goal, rounded. It can pass 100. Null when there is no goal.