Gift (Beta)
Monitor this page to keep up with the Gift API (Beta) latest changes and SKY API service releases.
2018-01-29
New
Added the following endpoint:
Operation | Method | Route |
---|---|---|
Attachment tags | GET | /attachmenttags |
Changed
We added the date
property to the attachment entity.
2017
2017-12-11
Changed
We added the package_id
property to the gift split entity.
2017-12-01
Changed
The Gift list endpoint now includes an option to filter gifts based on their post statuses. The optional
post_status
query parameter, which can be specified multiple times to imply a logical OR, filters the results to only include gifts with the specified post statuses. For example,post_status=DoNotPost&post_status=Posted
filters the results to only include gifts that are marked either DoNotPost or Posted.The Gift list endpoint now includes an option to filter gifts based on their gift types. The optional
gift_type
query parameter, which can be specified multiple times to imply a logical OR, filters the results to only include gifts with the specified gift types. For example,gift_type=MatchingGiftPledge&gift_type=RecurringGift
filters the results to only include gifts with the MatchingGiftPledge or RecurringGift types.
2017-11-01
Changed
We added the batch_number
property to the gift entity. This property is read-only.
2017-10-27
New
Added the following endpoint:
Operation | Method | Route |
---|---|---|
Gift (Create) | POST | /gifts |
Changed
The Gift list endpoint now includes an option to filter gifts based on their associated constituents. The optional constituent_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 constituent record IDs. For example, &constituent_id=1242&constituent_id=385
filters the results to only include gifts associated with two constituent records: "1242" and "385."
2017-10-04
Changed
We added the acknowledgements
, receipts
, and balance
properties to the gift entity.
2017-09-07
New
Added the following endpoint:
Operation | Method | Route |
---|---|---|
Gift custom field list (All gifts) | GET | /gifts/customfields |
Changed
The date
property on the gift entity no longer returns an offset. Instead, it now uses ISO-8601 format: 2015-09-18T00:00:00.
2017-08-30
Announcement: Breaking Changes Planned for Gift API
We will update the date
property on the gift entity to no longer return an offset. Instead, it will use ISO-8601 format: 2015-09-18T00:00:00.
2017-08-08
New
Added the following endpoint:
Operation | Method | Route |
---|---|---|
Gift subtypes (Get) | GET | /giftsubtypes |
Changed
We added the payments
property to the gift entity.
2017-08-04
Changed
We updated the next_link
property on the Gift list endpoint to be more consistent with other lists.
2017-06-23
Changed
We added the gift_aid_amount
and gift_aid_qualification_status
properties to the gift entity for UK tenants.
2017-04-25
New
Added the following endpoints:
Operation | Method | Route |
---|---|---|
Gift custom field (Create) | POST | /gifts/customfields |
Gift custom field (Edit) | PATCH | /gifts/customfields/{custom_field_id} |
Gift custom field categories (Get) | GET | /gifts/customfields/categories |
Gift custom field category values (Get) | GET | /gifts/customfields/values |
2017-03-20
Changed
We added the post_date
property to the gift entity.
2017-03-08
New
The Gift API has been released for a public beta. This API handles information related to gifts, including related entities such as gift splits, gift fundraisers, and soft credits.
The initial release contains endpoints to retrieve a list of all gifts, to retrieve gifts by their IDs, and to manage attachments. For more information, check out the entity and endpoint references.