Donation · Forms · Submissions
Get donation form submission
Gets a donation form submission, including the donor’s answers, for an organization and mandate. Provide the organization, mandate and submission IDs. The response also includes reviewers, payment status and the matching contact name when available.
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 with
mandate.readanddonationFormSubmission.read. - The submission must pass the applicable mandate and assigned-only access filters.
- Without
user.read, non-contact actors other than the current actor are masked. A contact actor’s nested user name and image are also masked unless it is the current actor. - Without
apiKey.read, API actors are masked. An API actor other than the current actor is also masked withoutuser.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
donationFormSubmissionIdidrequired
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/submissions/YOUR_DONATION_FORM_SUBMISSION_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/submissions/YOUR_DONATION_FORM_SUBMISSION_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/submissions/YOUR_DONATION_FORM_SUBMISSION_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 -
mandateid -
donationFormid -
donationFormNamestring -
frequencystringoneTimerecurring -
statusstringunreadpendingapprovedrejected -
amountintegerat most 9999999999
-
coveredFeesinteger0–9999999999
-
planobjectnullable3 properties
-
planid -
namestring -
intervalstringmonthquarterhalfYearyearcustomflexible
-
-
flexibleIntervalstringnullablemonthquarterhalfYearyear -
campaignidnullable -
campaignNamestringnullable1–100 characters
-
donorobject10 properties
-
typestringbusinessperson -
namestring1–81 characters
-
nameNormalizedstringat least 1 characters
-
nameSortstring1–81 characters
-
emailstring -
phonestring | string · phone -
firstNamestringat most 80 characters
-
lastNamestringat most 80 characters
-
organizationNamestringat most 81 characters
-
addressobjectnullable7 properties
-
countrystring -
statestring -
zipstringat most 10 characters
-
citystringat most 45 characters
-
addressLinestringat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
-
paymentMethodTypestringsepaCreditTransfersepaDirectDebitcashonline -
onlinePaymentProviderstringnullablestripepaypal -
wantsConfirmationboolean -
submissionobject2 properties
-
schemaobject[]5 properties
-
pageIdstring -
idstring -
labelstring -
itemCaptionstring -
fieldsobject[]9 properties
-
idstring -
keystring1–24 characters · pattern
^[A-Za-z_$][A-Za-z0-9_$]*$ -
typestring20 values
placeholderhtmlspacertextselectmultiSelectdatetimedateTimenumberfilesignatureratingmatrixbooleanaddresscalculatedinfotermsPrivacypaymentMethod -
labelstring1–140 characters
-
bindPropertyPathstring -
textobject1 property
-
formatstringtextmultilineregexemailphoneurlibanbic
-
-
dateobject1 property
-
formatstring
-
-
calculatedobject2 properties
-
resultTypestringnumberstringbooleandateOnlydateTimeoption -
optionsobject[]at most 1000 items
4 properties
-
idstring1–140 characters
-
valuestring1–140 characters
-
labelstring1–140 characters
-
hintstringat most 200 characters
-
-
-
matrixobject3 properties
-
rowsobject[]4 properties
-
idstring1–140 characters
-
valuestring1–140 characters
-
labelstring1–140 characters
-
hintstringat most 200 characters
-
-
columnsobject[]4 properties
-
idstring1–140 characters
-
valuestring1–140 characters
-
labelstring1–140 characters
-
hintstringat most 200 characters
-
-
multiSelectboolean
-
-
-
-
dataobject of one of 7 types | object of one of 7 types | object (recursive)[] | (one of 7 types)[][]The answers of a form, by the ID of each field. A repeating group holds a list of its entries under its own ID.
-
-
languagestringnullableende -
trackingobject6 properties
-
utmSourcestringat most 200 characters
-
utmMediumstringat most 200 characters
-
utmCampaignstringat most 200 characters
-
utmTermstringat most 200 characters
-
utmContentstringat most 200 characters
-
referrerstringat most 500 characters
-
-
receiptobjectnullable2 properties
-
receiptid -
receiptNumberstring
-
-
contactidnullable -
contractidnullable -
matchingContactidnullable -
dispatchStatusobjectnullable8 properties
-
openedAtstring · date-timenullable -
clickedAtstring · date-time -
unsubscribedAtstring · date-time -
sentAtstring · date-timenullable -
dispatchedByobjectnullable -
sendStatusstringnonemanualdispatchingdispatchedsentopenedfailed -
sendErrorstring -
sendPriceintegernullableat most 9999999999
-
-
rejectedAtstringnullable -
acceptedAtstringnullable -
reviewersobject[]Without
user.read,reviewersincludes only the caller’s own reviewer entry, if available. -
paymentStatusstringnullableunpaidpartialpaidpaymentStatusis null when the linked receipt or its payment status is unavailable. -
matchingContactNamestringnullablematchingContactNameis null when the matching contact or its name is unavailable.
{
"_id": "000000000000000000000001",
"mandate": "000000000000000000000001",
"donationForm": "000000000000000000000001",
"donationFormName": "string",
"frequency": "oneTime",
"status": "unread",
"amount": 1,
"coveredFees": 0,
"plan": {
"plan": "000000000000000000000001",
"name": "string",
"interval": "month"
},
"flexibleInterval": "month",
"campaign": "000000000000000000000001",
"campaignName": "string",
"donor": {
"type": "business",
"name": "string",
"nameNormalized": "string",
"nameSort": "string",
"email": "",
"phone": "",
"firstName": "string",
"lastName": "string",
"organizationName": "string",
"address": {
"country": "string",
"zip": "string",
"city": "string",
"addressLine": "string"
}
},
"paymentMethodType": "sepaCreditTransfer",
"onlinePaymentProvider": "stripe",
"wantsConfirmation": true,
"submission": {
"schema": [
{
"id": "string",
"label": "string",
"fields": [
{
"id": "string",
"type": "placeholder"
}
]
}
],
"data": {
"key": "2026-10-22T12:00:00Z"
}
},
"language": "en",
"tracking": {
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"referrer": "string"
},
"receipt": {
"receipt": "000000000000000000000001",
"receiptNumber": "string"
},
"contact": "000000000000000000000001",
"contract": "000000000000000000000001",
"matchingContact": "000000000000000000000001",
"dispatchStatus": {
"openedAt": "2026-06-15T22:30:00Z",
"sentAt": "2026-06-15T22:30:00Z",
"dispatchedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
},
"sendStatus": "none",
"sendError": "NO_CREDITS_ENOUGH",
"sendPrice": 1
},
"rejectedAt": "string",
"acceptedAt": "string",
"reviewers": [
{
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
}
],
"paymentStatus": "unpaid",
"matchingContactName": "string"
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The submission was not found. | If no submission matches the lookup, the endpoint returns HTTP 404 NOT_FOUND with message key routes.donation.forms.submissionNotFound. |
Errors nearly every request can meet are listed under Errors.