Donation ยท Campaigns
List donation campaigns
Returns the donation campaigns of a given mandate sorted by name, i.e. to assign donations to them, optionally searched by name and description. Unavailable campaigns are only included on request, otherwise the number of matching unavailable campaigns is returned
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonation.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
includeUnavailablebooleandefault
false -
searchTermstring
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' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/campaigns", {
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', 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
-
campaignsobject[]12 properties
-
_idid -
mandateid -
namestring1โ100 characters
-
descriptionstringat most 1000 characters
-
availableboolean -
goalintegernullableat most 9999999999
-
costCenter1numbernullable1โ99999999
-
costCenter2numbernullable1โ99999999
-
statisticsobject4 properties
-
totalValueintegerat least 0
-
donationCountintegerat least 0
-
donatorCountintegerat least 0
-
lastDonationDatestringnullable
-
-
formCountintegerat least 0
-
recurringCountintegerat least 0
-
recurringYearlyAmountintegerat least 0
-
-
hiddenCountintegerat least 0
Response200
{
"campaigns": [
{
"_id": "000000000000000000000001",
"mandate": "000000000000000000000001",
"name": "string",
"description": "string",
"available": true,
"goal": 1,
"costCenter1": 1,
"costCenter2": 1,
"statistics": {
"totalValue": 0,
"donationCount": 0,
"donatorCount": 0,
"lastDonationDate": "string"
},
"formCount": 0,
"recurringCount": 0,
"recurringYearlyAmount": 0
}
],
"hiddenCount": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.