Donation · Campaigns
Get donation campaign
Gets a donation campaign for an organization and mandate using the campaign ID. Returns the campaign details and statistics, recurring donation totals, and any associated donation forms the caller may read.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
mandate.read. - The caller needs
donation.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
campaignIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/campaigns/YOUR_CAMPAIGN_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/campaigns/YOUR_CAMPAIGN_ID", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/campaigns/YOUR_CAMPAIGN_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
_idid -
namestring1–100 characters
-
availableboolean -
goalintegernullableat most 9999999999
-
statisticsobject4 properties
-
totalValueintegerat least 0
-
donationCountintegerat least 0
-
donatorCountintegerat least 0
-
lastDonationDatestringnullable
-
-
recurringCountintegerat least 0
-
recurringYearlyAmountintegerat least 0
-
formsobject[]nullableformsis null if the caller does not havedonationForm.read.3 properties
-
_idid -
namestring -
availableboolean
-
Response200
{
"_id": "000000000000000000000001",
"name": "string",
"available": true,
"goal": 1,
"statistics": {
"totalValue": 0,
"donationCount": 0,
"donatorCount": 0,
"lastDonationDate": "string"
},
"recurringCount": 0,
"recurringYearlyAmount": 0,
"forms": [
{
"_id": "000000000000000000000001",
"name": "string",
"available": true
}
]
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The campaign was not found. | If the campaign is not found, the endpoint returns HTTP 404 with key routes.donation.campaigns.campaignNotFound. |
Errors nearly every request can meet are listed under Errors.