Donation · Forms
List donation forms
Returns the donation forms of a mandate, optionally searched by name or limited to a campaign
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonationForm.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
sortobject of stringascdescKeys: one of 12 values
_idmandatenameavailablecampaignunreadpendingapprovedrejectedcampaignNameoneTime.enabledrecurring.enabled -
limitinteger0–100 · default
50 -
offsetintegerat least 0 · default
0 -
returnCountbooleandefault
false -
campaignid -
searchTermstring
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/list' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/list", {
method: "POST",
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' => 'POST',
'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/forms/list', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
countintegerat least 0
-
formsobject[]12 properties
-
_idid -
mandateid -
namestring1–64 characters
-
availableboolean -
campaignidnullable -
unreadintegerat least 0
-
pendingintegerat least 0
-
approvedintegerat least 0
-
rejectedintegerat least 0
-
campaignNamestringnullable -
oneTimeobject1 property
-
enabledboolean
-
-
recurringobject1 property
-
enabledboolean
-
-
Response200
{
"count": 0,
"forms": [
{
"_id": "000000000000000000000001",
"mandate": "000000000000000000000001",
"name": "string",
"available": true,
"campaign": "000000000000000000000001",
"unread": 0,
"pending": 0,
"approved": 0,
"rejected": 0,
"campaignName": "string",
"oneTime": {
"enabled": true
},
"recurring": {
"enabled": true
}
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.