Skip to content
campaiDeveloper
campai.com

Donation ยท Campaigns

GET/{organizationId}/{mandateId}/donation/campaignsReads only

List donation campaigns

Returns the donation campaigns of a given mandate sorted by name, i.e. to assign donations to them, optionally searched by name and description. Unavailable campaigns are only included on request, otherwise the number of matching unavailable campaigns is returned

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • includeUnavailableboolean

    default false

  • searchTermstring
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/campaigns' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

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

      1โ€“100 characters

    • descriptionstring

      at most 1000 characters

    • availableboolean
    • goalintegernullable

      at most 9999999999

    • costCenter1numbernullable

      1โ€“99999999

    • costCenter2numbernullable

      1โ€“99999999

    • statisticsobject
      4 properties
      • totalValueinteger

        at least 0

      • donationCountinteger

        at least 0

      • donatorCountinteger

        at least 0

      • lastDonationDatestringnullable
    • formCountinteger

      at least 0

    • recurringCountinteger

      at least 0

    • recurringYearlyAmountinteger

      at least 0

  • hiddenCountinteger

    at least 0

Response200
{
  "campaigns": [
    {
      "_id": "000000000000000000000001",
      "mandate": "000000000000000000000001",
      "name": "string",
      "description": "string",
      "available": true,
      "goal": 1,
      "costCenter1": 1,
      "costCenter2": 1,
      "statistics": {
        "totalValue": 0,
        "donationCount": 0,
        "donatorCount": 0,
        "lastDonationDate": "string"
      },
      "formCount": 0,
      "recurringCount": 0,
      "recurringYearlyAmount": 0
    }
  ],
  "hiddenCount": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.