Donation · Forms
Get donation form
Returns a donation form and its settings for the supplied organization, mandate and donation form IDs. The mandate ID may be null. Actor details in the response may be masked depending on the caller’s permissions.
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
donationForm.read. - Without
user.read, a non-contact actor other than the current actor is masked. - Without
user.read, a contact actor’s linked user is masked unless it is the current actor. - Without
apiKey.read, an API actor is masked. - The legacy
contact.readpermission also allows contact actors to be shown.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
donationFormIdidrequired
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/forms/YOUR_DONATION_FORM_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/YOUR_DONATION_FORM_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/forms/YOUR_DONATION_FORM_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 -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
mandateid -
namestring1–64 characters
-
availableboolean -
campaignidnullable -
contactTypestringmemberaddresscustomersponsorcontributoremployeesupplier -
createContactsForOneTimeboolean -
contentobject4 properties
-
titlestring1–100 characters
-
introTextstringat most 4000 characters
-
pageModestringsegmentsflowflowWithProgress -
showCampaignProgressboolean
-
-
oneTimeobject6 properties
-
enabledboolean -
amountsobject5 properties
-
suggestionsinteger[]at most 6 items · each at most 9999999999
-
defaultAmountintegernullableat most 9999999999
-
allowCustomAmountboolean -
minimumAmountintegernullableat most 9999999999
-
maximumAmountintegernullableat most 9999999999
-
-
accountintegernullable1–999999999
-
costCenter1numbernullable1–99999999
-
costCenter2numbernullable1–99999999
-
descriptionstring1–200 characters
-
-
recurringobject3 properties
-
enabledboolean -
plansobject[]at most 10 items
4 properties
-
planid -
labelstring1–64 characters
-
descriptionstringat most 300 characters
-
amountsobject5 properties
-
suggestionsinteger[]at most 6 items · each at most 9999999999
-
defaultAmountintegernullableat most 9999999999
-
allowCustomAmountboolean -
minimumAmountintegernullableat most 9999999999
-
maximumAmountintegernullableat most 9999999999
-
-
-
requireReviewboolean
-
-
feeCoverageobjectnullable3 properties
-
percentagenumber0–20
-
fixedAmountinteger0–9999999999
-
preSelectedboolean
-
-
donorobject4 properties
-
addressModestringnoneoptionalrequired -
applicantTypestringpersonorganizationboth -
requirePhoneboolean -
askForConfirmationboolean
-
-
paymentMethodsobject4 properties
-
sepaCreditTransferobjectnullable3 properties
-
internalboolean -
cashAccountid -
notestringat most 300 characters
-
-
sepaDirectDebitobjectnullable3 properties
-
internalboolean -
cashAccountid -
notestringat most 300 characters
-
-
onlineobjectnullable4 properties
-
internalboolean -
notestringat most 300 characters
-
stripebooleannullabledefault
true -
paypalbooleannullabledefault
false
-
-
cashobjectnullable2 properties
-
internalboolean -
notestringat most 300 characters
-
-
-
formobject5 properties
-
groupsobject[]12 properties
-
idstring1–24 characters
-
pageIdstring1–24 characters
-
labelstringat most 140 characters
-
hintstringat most 280 characters
-
fieldsobject[] -
disabledboolean | object2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
hiddenboolean | object2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
minItemsintegerat least 0
-
maxItemsinteger -
addItemCaptionstringat most 64 characters
-
itemCaptionstringat most 100 characters
-
itemModestringnoHeaderdraggable
-
-
pagesobject[]3 properties
-
idstring1–24 characters
-
labelstring1–40 characters
-
hintstringat most 280 characters
-
-
submitCaptionstring -
appearanceobject5 properties
-
accentColorstring -
accentTextColorstring -
boxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
groupBoxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
inputBoxobject8 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
labelFontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
heightnumberat least 0
-
-
-
validationsobject[]2 properties
-
conditionobject2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
messagestring1–500 characters
-
-
-
submitobject5 properties
-
submitCaptionstringat least 1 characters
-
useCaptchaboolean -
submittedTextstring1–4000 characters
-
navigateUrlstring · uri | string -
navigateWaitSecondsintegerat least 0
-
-
confirmationobject3 properties
-
oneTimeMailobjectnullable2 properties
-
subjectstring1–998 characters
-
messagestring1–10000 characters
-
-
recurringMailobjectnullable2 properties
-
subjectstring1–998 characters
-
messagestring1–10000 characters
-
-
acceptedMailobjectnullable2 properties
-
subjectstring1–998 characters
-
messagestring1–10000 characters
-
-
-
notificationsobject2 properties
-
oneTimeDonationsboolean -
minimumAmountintegernullableat most 9999999999
-
-
reviewerUserIdsstring[]at most 20 items · each at least 16 characters
-
reviewerRulesobject[]at most 50 items
2 properties
-
conditionobject2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
reviewerUserIdsstring[]1–50 items · each at least 16 characters
-
-
unreadintegerat least 0
-
pendingintegerat least 0
-
approvedintegerat least 0
-
rejectedintegerat least 0
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"mandate": "000000000000000000000001",
"name": "string",
"available": true,
"campaign": "000000000000000000000001",
"contactType": "member",
"createContactsForOneTime": true,
"content": {
"title": "string",
"introText": "string",
"pageMode": "segments",
"showCampaignProgress": true
},
"oneTime": {
"enabled": true,
"amounts": {
"suggestions": [
1
],
"defaultAmount": 1,
"allowCustomAmount": true,
"minimumAmount": 1,
"maximumAmount": 1
},
"account": 1,
"costCenter1": 1,
"costCenter2": 1,
"description": "string"
},
"recurring": {
"enabled": true,
"plans": [
{
"plan": "000000000000000000000001",
"label": "string",
"description": "string",
"amounts": {
"suggestions": [
1
],
"defaultAmount": 1,
"allowCustomAmount": true,
"minimumAmount": 1,
"maximumAmount": 1
}
}
],
"requireReview": true
},
"feeCoverage": {
"percentage": 0,
"fixedAmount": 0,
"preSelected": true
},
"donor": {
"addressMode": "none",
"applicantType": "person",
"requirePhone": true,
"askForConfirmation": true
},
"paymentMethods": {
"sepaCreditTransfer": {
"internal": true,
"cashAccount": "000000000000000000000001",
"note": "string"
},
"sepaDirectDebit": {
"internal": true,
"cashAccount": "000000000000000000000001",
"note": "string"
},
"online": {
"internal": true,
"note": "string",
"stripe": true,
"paypal": false
},
"cash": {
"internal": true,
"note": "string"
}
},
"form": {
"groups": [
{
"id": "string",
"label": "string",
"fields": [
{
"id": "string",
"type": "placeholder",
"name": "string"
}
]
}
]
},
"submit": {
"submitCaption": "string",
"useCaptcha": true,
"submittedText": "string",
"navigateUrl": "string",
"navigateWaitSeconds": 0
},
"confirmation": {
"oneTimeMail": {
"subject": "string",
"message": "string"
},
"recurringMail": {
"subject": "string",
"message": "string"
},
"acceptedMail": {
"subject": "string",
"message": "string"
}
},
"notifications": {
"oneTimeDonations": true,
"minimumAmount": 1
},
"reviewerUserIds": [
"string"
],
"reviewerRules": [
{
"condition": {
"operator": "and",
"conditions": [
null
]
},
"reviewerUserIds": [
"string"
]
}
],
"unread": 0,
"pending": 0,
"approved": 0,
"rejected": 0
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The donation form was not found. | If no matching donation form is found, the endpoint returns HTTP 404 with key routes.donation.forms.formNotFound. |
Errors nearly every request can meet are listed under Errors.