Skip to content
campaiDeveloper
campai.com

Donation · Forms

GET/{organizationId}/{mandateId}/donation/forms/{donationFormId}Reads only

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.read permission also allows contact actors to be shown.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormIdidrequired
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/YOUR_DONATION_FORM_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
  • organizationid
  • mandateid
  • namestring

    1–64 characters

  • availableboolean
  • campaignidnullable
  • contactTypestring
    member address customer sponsor contributor employee supplier
  • createContactsForOneTimeboolean
  • contentobject
    4 properties
    • titlestring

      1–100 characters

    • introTextstring

      at most 4000 characters

    • pageModestring
      segments flow flowWithProgress
    • showCampaignProgressboolean
  • oneTimeobject
    6 properties
    • enabledboolean
    • amountsobject
      5 properties
      • suggestionsinteger[]

        at most 6 items · each at most 9999999999

      • defaultAmountintegernullable

        at most 9999999999

      • allowCustomAmountboolean
      • minimumAmountintegernullable

        at most 9999999999

      • maximumAmountintegernullable

        at most 9999999999

    • accountintegernullable

      1–999999999

    • costCenter1numbernullable

      1–99999999

    • costCenter2numbernullable

      1–99999999

    • descriptionstring

      1–200 characters

  • recurringobject
    3 properties
    • enabledboolean
    • plansobject[]

      at most 10 items

      4 properties
      • planid
      • labelstring

        1–64 characters

      • descriptionstring

        at most 300 characters

      • amountsobject
        5 properties
        • suggestionsinteger[]

          at most 6 items · each at most 9999999999

        • defaultAmountintegernullable

          at most 9999999999

        • allowCustomAmountboolean
        • minimumAmountintegernullable

          at most 9999999999

        • maximumAmountintegernullable

          at most 9999999999

    • requireReviewboolean
  • feeCoverageobjectnullable
    3 properties
    • percentagenumber

      0–20

    • fixedAmountinteger

      0–9999999999

    • preSelectedboolean
  • donorobject
    4 properties
    • addressModestring
      none optional required
    • applicantTypestring
      person organization both
    • requirePhoneboolean
    • askForConfirmationboolean
  • paymentMethodsobject
    4 properties
    • sepaCreditTransferobjectnullable
      3 properties
      • internalboolean
      • cashAccountid
      • notestring

        at most 300 characters

    • sepaDirectDebitobjectnullable
      3 properties
      • internalboolean
      • cashAccountid
      • notestring

        at most 300 characters

    • onlineobjectnullable
      4 properties
      • internalboolean
      • notestring

        at most 300 characters

      • stripebooleannullable

        default true

      • paypalbooleannullable

        default false

    • cashobjectnullable
      2 properties
      • internalboolean
      • notestring

        at most 300 characters

  • formobject
    5 properties
    • groupsobject[]
      12 properties
      • idstring

        1–24 characters

      • pageIdstring

        1–24 characters

      • labelstring

        at most 140 characters

      • hintstring

        at most 280 characters

      • fieldsobject[]
      • disabledboolean | object
        2 properties
        • operatorstring
          and or
        • conditions(object (recursive) | object)[]

          at least 1 items

          4 properties
          • leftobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • cmpFuncstring
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • negateboolean
      • hiddenboolean | object
        2 properties
        • operatorstring
          and or
        • conditions(object (recursive) | object)[]

          at least 1 items

          4 properties
          • leftobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • cmpFuncstring
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • negateboolean
      • minItemsinteger

        at least 0

      • maxItemsinteger
      • addItemCaptionstring

        at most 64 characters

      • itemCaptionstring

        at most 100 characters

      • itemModestring
        noHeader draggable
    • pagesobject[]
      3 properties
      • idstring

        1–24 characters

      • labelstring

        1–40 characters

      • hintstring

        at most 280 characters

    • submitCaptionstring
    • appearanceobject
      5 properties
      • accentColorstring
      • accentTextColorstring
      • boxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumber
          • ynumber
          • blurnumber

            at least 0

          • spreadnumber

            at least 0

          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • groupBoxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumber
          • ynumber
          • blurnumber

            at least 0

          • spreadnumber

            at least 0

          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • inputBoxobject
        8 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumber
          • ynumber
          • blurnumber

            at least 0

          • spreadnumber

            at least 0

          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • labelFontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • heightnumber

          at least 0

    • validationsobject[]
      2 properties
      • conditionobject
        2 properties
        • operatorstring
          and or
        • conditions(object (recursive) | object)[]

          at least 1 items

          4 properties
          • leftobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • cmpFuncstring
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestring

              at least 1 characters

            Variant 2: 4 properties
            • sourceobject
              1 property
              • variablestring

                at least 1 characters

            • lookupobjectnullable
              1 property
              • variablestring

                at least 1 characters

            • arrayboolean
            • selectobject (recursive)
            Variant 3: 2 properties
            • funcstring
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | number
            Variant 5: 3 properties
            • ifobject (recursive)
            • thenobject (recursive)
            • elseobject (recursive)
          • negateboolean
      • messagestring

        1–500 characters

  • submitobject
    5 properties
    • submitCaptionstring

      at least 1 characters

    • useCaptchaboolean
    • submittedTextstring

      1–4000 characters

    • navigateUrlstring · uri | string
    • navigateWaitSecondsinteger

      at least 0

  • confirmationobject
    3 properties
    • oneTimeMailobjectnullable
      2 properties
      • subjectstring

        1–998 characters

      • messagestring

        1–10000 characters

    • recurringMailobjectnullable
      2 properties
      • subjectstring

        1–998 characters

      • messagestring

        1–10000 characters

    • acceptedMailobjectnullable
      2 properties
      • subjectstring

        1–998 characters

      • messagestring

        1–10000 characters

  • notificationsobject
    2 properties
    • oneTimeDonationsboolean
    • minimumAmountintegernullable

      at most 9999999999

  • reviewerUserIdsstring[]

    at most 20 items · each at least 16 characters

  • reviewerRulesobject[]

    at most 50 items

    2 properties
    • conditionobject
      2 properties
      • operatorstring
        and or
      • conditions(object (recursive) | object)[]

        at least 1 items

        4 properties
        • leftobject | object of any
          Variant 1: 1 property
          • variablestring

            at least 1 characters

          Variant 2: 4 properties
          • sourceobject
            1 property
            • variablestring

              at least 1 characters

          • lookupobjectnullable
            1 property
            • variablestring

              at least 1 characters

          • arrayboolean
          • selectobject (recursive)
          Variant 3: 2 properties
          • funcstring
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • paramsobject (recursive)[]
          Variant 4: 1 property
          • literalnumber[] | number
          Variant 5: 3 properties
          • ifobject (recursive)
          • thenobject (recursive)
          • elseobject (recursive)
        • cmpFuncstring
          15 values
          eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
        • rightobject | object of any
          Variant 1: 1 property
          • variablestring

            at least 1 characters

          Variant 2: 4 properties
          • sourceobject
            1 property
            • variablestring

              at least 1 characters

          • lookupobjectnullable
            1 property
            • variablestring

              at least 1 characters

          • arrayboolean
          • selectobject (recursive)
          Variant 3: 2 properties
          • funcstring
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • 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

  • unreadinteger

    at least 0

  • pendinginteger

    at least 0

  • approvedinteger

    at least 0

  • rejectedinteger

    at least 0

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

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