Donation · Forms · Submissions
List donation form submissions
Returns the submissions of donation forms, optionally limited to a form, a campaign, a frequency or statuses and searched by the name of the donator
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonationFormSubmission.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
sortobject of stringascdescKeys: one of 53 values
_idmandatedonationFormdonationFormNamefrequencystatusamountcoveredFeesplan.planplan.nameplan.intervalcampaigncampaignNamedonor.typedonor.namedonor.nameNormalizeddonor.nameSortdonor.emaildonor.phonedonor.firstNamedonor.lastNamedonor.organizationNamedonor.address.countrydonor.address.statedonor.address.zipdonor.address.citydonor.address.addressLinedonor.address.details1donor.address.details2paymentMethodTypewantsConfirmationreceipt.receiptreceipt.receiptNumbercontactcontractmatchingContactdispatchStatus.openedAtdispatchStatus.clickedAtdispatchStatus.unsubscribedAtdispatchStatus.sentAtdispatchStatus.dispatchedBy.namedispatchStatus.dispatchedBy.typedispatchStatus.dispatchedBy.userIddispatchStatus.dispatchedBy.image.resourcedispatchStatus.dispatchedBy.image.fileNamedispatchStatus.dispatchedBy.image.contentTypedispatchStatus.dispatchedBy.image.fileSizeBytesdispatchStatus.dispatchedBy.keydispatchStatus.sendStatusdispatchStatus.sendErrordispatchStatus.sendPricecreatedAtpaymentStatus -
limitinteger0–100 · default
50 -
offsetintegerat least 0 · default
0 -
returnCountbooleandefault
false -
donationFormIdid -
campaignid -
frequencystringoneTimerecurring -
statusstring[]unreadpendingapprovedrejected -
searchTermstring
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/submissions/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/submissions/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/submissions/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
-
submissionsobject[]21 properties
-
_idid -
mandateid -
donationFormid -
donationFormNamestring -
frequencystringoneTimerecurring -
statusstringunreadpendingapprovedrejected -
amountintegerat most 9999999999
-
coveredFeesinteger0–9999999999
-
planobjectnullable3 properties
-
planid -
namestring -
intervalstringmonthquarterhalfYearyearcustomflexible
-
-
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 -
wantsConfirmationboolean -
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
-
-
createdAtstring · date-timenullable -
paymentStatusstringnullableunpaidpartialpaid
-
{
"count": 0,
"submissions": [
{
"_id": "000000000000000000000001",
"mandate": "000000000000000000000001",
"donationForm": "000000000000000000000001",
"donationFormName": "string",
"frequency": "oneTime",
"status": "unread",
"amount": 1,
"coveredFees": 0,
"plan": {
"plan": "000000000000000000000001",
"name": "string",
"interval": "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",
"wantsConfirmation": true,
"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
},
"paymentStatus": "unpaid"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.