Skip to content
campaiDeveloper
campai.com

Donation · Forms · Submissions

GET/{organizationId}/{mandateId}/donation/forms/submissions/{donationFormSubmissionId}Reads only

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.read and donationFormSubmission.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 without user.read.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormSubmissionIdidrequired
Request
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'

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
  • 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
  • flexibleIntervalstringnullable
    month quarter halfYear year
  • 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
  • onlinePaymentProviderstringnullable
    stripe paypal
  • wantsConfirmationboolean
  • submissionobject
    2 properties
    • schemaobject[]
      5 properties
      • pageIdstring
      • idstring
      • labelstring
      • itemCaptionstring
      • fieldsobject[]
        9 properties
        • idstring
        • keystring

          1–24 characters · pattern ^[A-Za-z_$][A-Za-z0-9_$]*$

        • typestring
          20 values
          placeholder html spacer text select multiSelect date time dateTime number file signature rating matrix boolean address calculated info termsPrivacy paymentMethod
        • labelstring

          1–140 characters

        • bindPropertyPathstring
        • textobject
          1 property
          • formatstring
            text multiline regex email phone url iban bic
        • dateobject
          1 property
          • formatstring
        • calculatedobject
          2 properties
          • resultTypestring
            number string boolean dateOnly dateTime option
          • optionsobject[]

            at most 1000 items

            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at most 200 characters

        • matrixobject
          3 properties
          • rowsobject[]
            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at most 200 characters

          • columnsobject[]
            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at 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.

  • languagestringnullable
    en de
  • trackingobject
    6 properties
    • utmSourcestring

      at most 200 characters

    • utmMediumstring

      at most 200 characters

    • utmCampaignstring

      at most 200 characters

    • utmTermstring

      at most 200 characters

    • utmContentstring

      at most 200 characters

    • referrerstring

      at most 500 characters

  • 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

  • rejectedAtstringnullable
  • acceptedAtstringnullable
  • reviewersobject[]

    Without user.read, reviewers includes only the caller’s own reviewer entry, if available.

  • paymentStatusstringnullable
    unpaid partial paid

    paymentStatus is null when the linked receipt or its payment status is unavailable.

  • matchingContactNamestringnullable

    matchingContactName is null when the matching contact or its name is unavailable.

Response200
{
  "_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

StatusErrorWhen
404The 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.