| Authentication | |
| Yes | PRIVATE API Token |
| URI Parameters | |
| team_name | Filters records to those with a matching team name |
| keyword | Filters records to those that are associated to specified keyword |
| campaign | Filters records to those with are associated to specified campaign |
| start_date | Date in %m/%d/%y format, will filter records to all created on or after start_date |
| end_date | Date in %m/%d/%y format, will filter records to all created on or before end_date |
| Response Parameters | |
| teams | |
| Id | Unique ID for the record |
| Name | Name of the team |
| Created At | The date the record was created |
| Updated At | The date the record was most recently updated |
| Campaigns Keyword Id | The Id of the campaigns keyword object that the team is under |
| Total | Total raised under the team |
| Team Fundraising Goal | Goal amount set for the team |
| Call to Action | Teams’ custom CTA |
| Campaigns Keyword Category Id | The Id for the team category (useful for creating teams with Categories with add_teams endpoint) |
| Alternative Team Id | The alternate Id text for the team |
WINDOWS USERS – Please see note at the end
This endpoint will return an array of "peer_fundraising_team"s with the above response parameters.
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"team_name":"Local PTA","start_date":"1/1/2015","end_date":"1/31/2015","campaign":"School"}' "https://fundraise.givesmart.com/api/v2/teams"
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 " {\"status\":\"collected,pending\",\"transaction_type\":\"sale,credit\",\"amount_min\":\"50.00\"}" https://fundraise.givesmart.com/api/v2/reports/transactions.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?