Changes To The Gift API 5829

Changes To The Gift API

Published
The Gift API was updated on 07/08/2019. See our Changelog entries for more information.

The Gift list (GET) endpoint now includes the ability to filter by the system record IDs of campaigns, funds, and appeals.
  • The optional campaign_id query parameter, which can be specified multiple times to imply a logical OR, filters the results to only include gifts associated with the specified campaigns.
  • The optional fund_id query parameter, which can be specified multiple times to imply a logical OR, filters the results to only include gifts associated with the specified funds.
  • The optional appeal_id query parameter, which can be specified multiple times to imply a logical OR, filters the results to only include gifts associated with the specified appeals.
For example, fund_id=280 filters the results to only include gifts associated with fund "280," while fund_id=280&fund_id=1232 returns gifts associated with either fund “280” or fund “1232” system record IDs.

A combination of these filters can be specified to imply a logical AND. For example, campaign_id=57&fund_id=280 filters the results to only include gifts associated with both campaign "57" and fund "280."

Note: When a gift is split between multiple campaigns, funds, or appeals, it is returned in the results if any amount of the gift is applied to the specified fundraising effort. For example, fund_id=280 returns a $100.00 gift if it contains splits such that $30.00 is applied to fund “280” and $70.00 is applied to another. The value of the gift amount returned is $100.00.
News SKY Developer Announcements 07/08/2019 2:21pm EDT

Leave a Comment

Check back soon!

Share: