Skip to content
campaiDeveloper
campai.com

Donation · Donations

POST/{organizationId}/{mandateId}/donation/donations/export

Export donations

Exports the donations of a given mandate as CSV or Excel file, filtered like the donation list and including each received donation with its booking

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

  • searchTermstring
  • periodobject
    2 properties
    • fromstring · date-timerequired
    • tostring · date-timerequired
  • includeRevokedboolean

    default true

  • viewstring

    default "all"

    all pending notRequired created thanked revoked
  • donatorAccountinteger

    1–999999999

  • campaignid
  • austrianReportingStatusstring
    notReported processing reported changed error notReportable
  • formatstringrequired
    csv xlsx
  • formatOptionsobject
    1 property
    • xlsxobject
      2 properties
      • arrayFormatstring
        line comma columns
      • unmergedGroupHeaderboolean
  • propertyPathsstring[]

    1–1000 items · each at least 1 characters

  • selectionobject
    2 properties
    • excludeIdsid[]

      1–1000 items

    • idsid[]

      1–1000 items

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

object

Response200
{
  "state": "empty"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.