Skip to content
campaiDeveloper
campai.com

Donation · Donations · Statistics

GET/{organizationId}/{mandateId}/donation/donations/statistics/recurringDonationsReads only

Get recurring donations

Returns what running recurring donations bring per year in cents, today and at the start of a period. Recurring donations are the contracts of donation plans

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • fromDatestringrequired
  • toDatestringrequired
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/donations/statistics/recurringDonations' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • yearlyAmountnumber

    at least 0

  • yearlyAmountAtStartnumber

    at least 0

Response200
{
  "yearlyAmount": 0,
  "yearlyAmountAtStart": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.