Skip to content
campaiDeveloper
campai.com

Donation ยท Donators

GET/{organizationId}/{mandateId}/donation/donators/{account}Reads only

Get donator

Returns the donator with a given debtor account: the total, number, first and last date of all donations which are not revoked, the ten latest donations and the running recurring donations

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
Also checked, depending on the request and the records it touches
  • contract.read

Request

Path parameters

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

Response

200 Successful response

Content-Type: application/json

  • namestring
  • accountnumber
  • totalValuenumber
  • donationCountinteger

    at least 0

  • firstDonationDatestring
  • lastDonationDatestring
  • donationsobject[]
    6 properties
    • donationid
    • datestring
    • valuenumber
    • typestring
      cash membershipFee assetStock refund nonCash
    • campaignNamestringnullable
    • confirmationStatusstring
      pending notRequired created thanked
  • recurringobject[]nullable
    4 properties
    • contractid
    • planNamestring
    • amountnumbernullable
    • intervalstring
      month quarter halfYear year custom flexible
Response200
{
  "name": "string",
  "account": 1,
  "totalValue": 1,
  "donationCount": 0,
  "firstDonationDate": "string",
  "lastDonationDate": "string",
  "donations": [
    {
      "donation": "000000000000000000000001",
      "date": "string",
      "value": 1,
      "type": "cash",
      "campaignName": "string",
      "confirmationStatus": "pending"
    }
  ],
  "recurring": [
    {
      "contract": "000000000000000000000001",
      "planName": "string",
      "amount": 1,
      "interval": "month"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.