Skip to content
campaiDeveloper
campai.com

Donation · Forms · Submissions

POST/{organizationId}/{mandateId}/donation/forms/submissions/listReads only

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.read
  • donationFormSubmission.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • sortobject of string
    asc desc
    Keys: one of 53 values
    _id mandate donationForm donationFormName frequency status amount coveredFees plan.plan plan.name plan.interval campaign campaignName donor.type donor.name donor.nameNormalized donor.nameSort donor.email donor.phone donor.firstName donor.lastName donor.organizationName donor.address.country donor.address.state donor.address.zip donor.address.city donor.address.addressLine donor.address.details1 donor.address.details2 paymentMethodType wantsConfirmation receipt.receipt receipt.receiptNumber contact contract matchingContact dispatchStatus.openedAt dispatchStatus.clickedAt dispatchStatus.unsubscribedAt dispatchStatus.sentAt dispatchStatus.dispatchedBy.name dispatchStatus.dispatchedBy.type dispatchStatus.dispatchedBy.userId dispatchStatus.dispatchedBy.image.resource dispatchStatus.dispatchedBy.image.fileName dispatchStatus.dispatchedBy.image.contentType dispatchStatus.dispatchedBy.image.fileSizeBytes dispatchStatus.dispatchedBy.key dispatchStatus.sendStatus dispatchStatus.sendError dispatchStatus.sendPrice createdAt paymentStatus
  • limitinteger

    0–100 · default 50

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

  • donationFormIdid
  • campaignid
  • frequencystring
    oneTime recurring
  • statusstring[]
    unread pending approved rejected
  • 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/submissions/list' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • countinteger

    at least 0

  • submissionsobject[]
    21 properties
    • _idid
    • mandateid
    • donationFormid
    • donationFormNamestring
    • frequencystring
      oneTime recurring
    • statusstring
      unread pending approved rejected
    • amountinteger

      at most 9999999999

    • coveredFeesinteger

      0–9999999999

    • planobjectnullable
      3 properties
      • planid
      • namestring
      • intervalstring
        month quarter halfYear year custom flexible
    • campaignidnullable
    • campaignNamestringnullable

      1–100 characters

    • donorobject
      10 properties
      • typestring
        business person
      • namestring

        1–81 characters

      • nameNormalizedstring

        at least 1 characters

      • nameSortstring

        1–81 characters

      • emailstring
      • phonestring | string · phone
      • firstNamestring

        at most 80 characters

      • lastNamestring

        at most 80 characters

      • organizationNamestring

        at most 81 characters

      • addressobjectnullable
        7 properties
        • countrystring
        • statestring
        • zipstring

          at most 10 characters

        • citystring

          at most 45 characters

        • addressLinestring

          at most 45 characters

        • details1string

          at most 45 characters

        • details2string

          at most 45 characters

    • paymentMethodTypestring
      sepaCreditTransfer sepaDirectDebit cash online
    • wantsConfirmationboolean
    • receiptobjectnullable
      2 properties
      • receiptid
      • receiptNumberstring
    • contactidnullable
    • contractidnullable
    • matchingContactidnullable
    • dispatchStatusobjectnullable
      8 properties
      • openedAtstring · date-timenullable
      • clickedAtstring · date-time
      • unsubscribedAtstring · date-time
      • sentAtstring · date-timenullable
      • dispatchedByobjectnullable
      • sendStatusstring
        none manual dispatching dispatched sent opened failed
      • sendErrorstring
      • sendPriceintegernullable

        at most 9999999999

    • createdAtstring · date-timenullable
    • paymentStatusstringnullable
      unpaid partial paid
Response200
{
  "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.