Skip to content
campaiDeveloper
campai.com

Donation · Donators

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

List donators

Returns the donators of a given mandate with their total, number, average and last donation within a period, optionally limited to a campaign, searched and filtered by these values

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

Body

Content-Type: application/json

  • fromDatestringrequired
  • toDatestringrequired
  • campaignidrequirednullable
  • searchTermstring
  • userFilterstringnullable

    A stringified json object representing a property filter

  • sortstring

    default "totalValue"

    name account totalValue donationCount averageValue lastDonationDate
  • sortBystring

    default "desc"

    asc desc
  • offsetinteger

    at least 0 · default 0

  • limitinteger

    1–1000 · default 50

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/donators/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

  • donatorsobject[]
    7 properties
    • keystring
    • namestring
    • accountnumbernullable
    • totalValuenumber
    • donationCountinteger

      at least 0

    • averageValuenumber
    • lastDonationDatestring
  • countinteger

    at least 0

  • totalValuenumber
  • donationCountinteger

    at least 0

Response200
{
  "donators": [
    {
      "key": "string",
      "name": "string",
      "account": 1,
      "totalValue": 1,
      "donationCount": 0,
      "averageValue": 1,
      "lastDonationDate": "string"
    }
  ],
  "count": 0,
  "totalValue": 1,
  "donationCount": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.