Skip to content
campaiDeveloper
campai.com

Donation ยท Donators

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

Export donators

Exports the donators of a given mandate with their total, number, average and last donation within a period as PDF, CSV or Excel file, searched, filtered and sorted like the donator list

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

  • formatstringrequired
    html pdf excel csv
  • 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
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/export' \
  --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

  • namestring
  • dataobject
    2 properties
    • contentstring
    • zipboolean
  • emptyboolean
Response200
{
  "name": "string",
  "data": {
    "content": "string"
  },
  "empty": true
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.