API Documentation

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

Fundraising exports

Export large sets of broad data from mod_fundraising

Accept header for requests to Fundraising exports

application/vnd.procurios.fundraising+json; version=1

Pledges GET

URL: /l/fundraising_api/pledge/export

Scope:

fundraising/pledge/export
Last used: Never

Get a lot of information on pledges

Parameters

Parameter Type Description
page int

The api will provide 25 results per page
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
relationIds int[]

Limit the results to the given relationIds, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Donations GET

URL: /l/fundraising_api/donation/export

Scope:

fundraising/donation/export
Last used: Never

Get a lot of information on donations

Parameters

Parameter Type Description
page int

The api will provide 25 results per page
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
relationIds int[]

Limit the results to the given relationIds, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Totals GET

URL: /l/fundraising_api/totals

Scope:

fundraising/totals
Last used: Never

Collect a summary of donation information (in cents) for a fund and/or campaign and/or period

Parameters

Parameter Type Description
from string

The api will provide results from this date (given as yyyy-mm-dd)
until string

The api will provide results before this date (given as yyyy-mm-dd)
campaign int[]

Limit the results to the given values, as a single integer, comma-separated list of integers, or array of integers
fund int[]

Limit the results to the given values, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Totals

Request

json

Response

jsonStatus: 200
{
    "donations": 15,
    "donors": 12,
    "total_amount": {
        "currency": "EUR",
        "amount": 255000
    },
    "average_amount": {
        "currency": "EUR",
        "amount": 3000
    },
    "average_per_donor": {
        "currency": "EUR",
        "amount": 2500
    }
}