| Authentication | |
| Yes | PRIVATE API Token |
| URI Parameters | |
| phone | Filters records to those with a matching phone |
| keyword | Filters records to those that are associated to specified keyword |
| name | Filters records to those with a matching first or last name |
| 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 |
| list_name | Filters records to those that are associated to specified list |
| exclude | Takes a comma delimited list of field names and excludes those fields from the results |
| Response Parameters | |
| people | |
| Id | Unique ID for the record |
| Phone | Mobile phone number, if available, for the record |
| Subscription Status | The state of subscription (i.e. invited, subscribed, unsubscribed) for the record |
| First Name | |
| Last Name | |
| Street Address | |
| City | |
| State | |
| Zip | |
| Created At | Datetime stamp for when the record was created |
| Updated At | Datetime stamp for when the record was updated |
| Custom Columns | Any custom fields that appear on your Forms will appear as columns with the same name |
WINDOWS USERS – Please see note at the end
This endpoint will return an array of "person"s with the above response parameters. Since including every one of your Custom Fields may become unwieldy, especially as time goes on, we also allow for an input parameter “exclude” which will strike your selected fields from the returned report – you can find out all list names that can be stricken by using the GET people_available_fields endpoint.
curl -v -D - -H 'Authorization: Token token="[private_api_token_here]"' -H "Accept: application/json" -H "Content-type: application/json" -X GET -d ' {"name":"Smith","start_date":"1/1/2015","end_date":"1/31/2015","exclude":"[field_name],[field_name],[field_name]"}' "https://fundraise.givesmart.com/api/v2/reports/people.json?"
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?