Authentication | |
Yes | PRIVATE API Token |
URI Parameters | |
event_id | Keyword ID |
Response Parameters | |
fundraiser |
WINDOWS USERS – Please see note at the end
In order to prevent timeouts we use an asynchronous system – making the API call will return a fundraiser report ID which you can use to retrieve the report asynchronously
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"event_id":"138"}' "https://fundraise.givesmart.com/api/v2/fundraisers.json?"
Will return:
{ "id": "[fundraiser_report_id_here]" }
The ID can then be passed like so:
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"id":"[report_id_here]"}' "https://fundraise.givesmart.com/api/v2/fundraisers/results.json?"
Please note that the .json suffix here can be replaced with .xml or .csv to have the payload delivered in the desired format
By default these commands will not work on the Windows command prompt as it does not escape double quotes properly. Windows users can use Cygwin to have a Unix-like command prompt, or they can structure the calls to escape the quotes like so:
curl -H "Authorization: Token token=\"[private_api_token_here]\"" -H "Accept: application/json" -H "Content-type: application/json" -X GET -d "{\"event_id\":\"138\"}" https://fundraise.givesmart.com/api/v2/fundraisers.json?
and
curl -H "Authorization: Token token=\"[private_api_token_here]\"" -H "Accept: application/json" -H "Content-type: application/json" -X GET -d " {\"id\":\"[report_id_here]\"}" https://fundraise.givesmart.com/api/v2/reports/results.json?