Get a Campaign
curl --request GET \
--url https://prod-api.raisedonors.com/api/Campaign/{id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://prod-api.raisedonors.com/api/Campaign/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Campaign/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Campaign/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Campaign/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://prod-api.raisedonors.com/api/Campaign/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Campaign/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Campaign/{id}';
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 88,
"name": "Year-End Giving 2025",
"description": "Year-end multi-channel giving campaign.",
"startDate": "2025-11-01",
"endDate": "2025-12-31",
"duration": "60",
"canSync": true,
"crmKey": "2011",
"crmKeyUrls": {
"VirtuousCRM": {
"crmKey": "2011",
"url": "https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"
}
},
"applySegmentToRecurringGifts": true,
"givingGoal": 250000,
"givingGoalFormatted": "$250,000.00",
"hasGivingGoal": true,
"raisedAmount": "$87,340.00",
"raisedPercentage": 34.9,
"totalGiftGoal": 600,
"hasTotalGiftGoal": true,
"totalGifts": 467,
"totalGiftsPercentage": 77.8,
"totalDonors": 412,
"averageGiftGoal": 250,
"averageGiftGoalFormatted": "$250.00",
"averageGiftAmount": "$187.02",
"hasAverageGiftGoal": true,
"totalVisitors": 5842,
"conversionRate": "8.0%",
"createdDateTime": "2025-10-15T09:00:00Z",
"modifiedDateTime": "2025-11-15T08:00:00Z"
}{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Campaign/{id}"
}{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "Campaign 88 was not found.",
"instance": "/api/Campaign/88"
}Campaign
Get a Campaign
Returns a single campaign by ID, including its goals and the totals raised against them.
GET
https://prod-api.raisedonors.com
/
api
/
Campaign
/
{id}
Get a Campaign
curl --request GET \
--url https://prod-api.raisedonors.com/api/Campaign/{id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://prod-api.raisedonors.com/api/Campaign/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Campaign/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Campaign/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Campaign/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://prod-api.raisedonors.com/api/Campaign/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Campaign/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Campaign/{id}';
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 88,
"name": "Year-End Giving 2025",
"description": "Year-end multi-channel giving campaign.",
"startDate": "2025-11-01",
"endDate": "2025-12-31",
"duration": "60",
"canSync": true,
"crmKey": "2011",
"crmKeyUrls": {
"VirtuousCRM": {
"crmKey": "2011",
"url": "https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"
}
},
"applySegmentToRecurringGifts": true,
"givingGoal": 250000,
"givingGoalFormatted": "$250,000.00",
"hasGivingGoal": true,
"raisedAmount": "$87,340.00",
"raisedPercentage": 34.9,
"totalGiftGoal": 600,
"hasTotalGiftGoal": true,
"totalGifts": 467,
"totalGiftsPercentage": 77.8,
"totalDonors": 412,
"averageGiftGoal": 250,
"averageGiftGoalFormatted": "$250.00",
"averageGiftAmount": "$187.02",
"hasAverageGiftGoal": true,
"totalVisitors": 5842,
"conversionRate": "8.0%",
"createdDateTime": "2025-10-15T09:00:00Z",
"modifiedDateTime": "2025-11-15T08:00:00Z"
}{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Campaign/{id}"
}{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "Campaign 88 was not found.",
"instance": "/api/Campaign/88"
}The response covers the campaign’s date range, its giving, total gift, and average gift goals, and the progress against them:
raisedAmount, totalGifts, totalDonors, totalVisitors, and conversionRate.Authorizations
Response
OK
Represents the detailed view of a campaign returned by create, update, and single-campaign retrieval endpoints.
Was this page helpful?