Skip to content
campaiDeveloper
campai.com

Donation · Campaigns

GET/{organizationId}/{mandateId}/donation/campaigns/{campaignId}Reads only

Get donation campaign

Gets a donation campaign for an organization and mandate using the campaign ID. Returns the campaign details and statistics, recurring donation totals, and any associated donation forms the caller may read.

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • campaignIdidrequired
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/YOUR_CAMPAIGN_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _idid
  • namestring

    1–100 characters

  • availableboolean
  • goalintegernullable

    at most 9999999999

  • statisticsobject
    4 properties
    • totalValueinteger

      at least 0

    • donationCountinteger

      at least 0

    • donatorCountinteger

      at least 0

    • lastDonationDatestringnullable
  • recurringCountinteger

    at least 0

  • recurringYearlyAmountinteger

    at least 0

  • formsobject[]nullable

    forms is null if the caller does not have donationForm.read.

    3 properties
    • _idid
    • namestring
    • availableboolean
Response200
{
  "_id": "000000000000000000000001",
  "name": "string",
  "available": true,
  "goal": 1,
  "statistics": {
    "totalValue": 0,
    "donationCount": 0,
    "donatorCount": 0,
    "lastDonationDate": "string"
  },
  "recurringCount": 0,
  "recurringYearlyAmount": 0,
  "forms": [
    {
      "_id": "000000000000000000000001",
      "name": "string",
      "available": true
    }
  ]
}

Errors

Other errors

StatusErrorWhen
404The campaign was not found.If the campaign is not found, the endpoint returns HTTP 404 with key routes.donation.campaigns.campaignNotFound.

Errors nearly every request can meet are listed under Errors.