Skip to content
campaiDeveloper
campai.com

Donation · Forms

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

List donation forms

Returns the donation forms of a mandate, optionally searched by name or limited to a campaign

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • sortobject of string
    asc desc
    Keys: one of 12 values
    _id mandate name available campaign unread pending approved rejected campaignName oneTime.enabled recurring.enabled
  • limitinteger

    0–100 · default 50

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

  • campaignid
  • 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/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

  • formsobject[]
    12 properties
    • _idid
    • mandateid
    • namestring

      1–64 characters

    • availableboolean
    • campaignidnullable
    • unreadinteger

      at least 0

    • pendinginteger

      at least 0

    • approvedinteger

      at least 0

    • rejectedinteger

      at least 0

    • campaignNamestringnullable
    • oneTimeobject
      1 property
      • enabledboolean
    • recurringobject
      1 property
      • enabledboolean
Response200
{
  "count": 0,
  "forms": [
    {
      "_id": "000000000000000000000001",
      "mandate": "000000000000000000000001",
      "name": "string",
      "available": true,
      "campaign": "000000000000000000000001",
      "unread": 0,
      "pending": 0,
      "approved": 0,
      "rejected": 0,
      "campaignName": "string",
      "oneTime": {
        "enabled": true
      },
      "recurring": {
        "enabled": true
      }
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.