Gift
This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.
GET
Gift list
Returns a paginated list of gifts.
The default sorting behavior is to list gifts in ascending order based on theid.
However, the last_modified parameter overrides the default sorting behavior to list gifts in ascending order based on when they were last modified, and the date_added parameter overrides the default sorting behavior to list gifts in ascending order based on when they were created. The last_modified and date_added parameters also add the sort_token parameter to the next_link URL to ensure that gifts are stably sorted and that order persists when changes occur while working through a paginated list.
If the last_modified and date_added parameters are both specified, the sorting behavior is to list gifts based on when they were last modified.
Note: This endpoint returns data with an average latency of about 30 minutes.
Try it
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| date_added | string | Represents a filter for gifts created on or after the specified date. The filter respects time offsets from UTC per the ISO-8601 format: 2016-05-05T17:59:31.1600745-04:00. |
|
| last_modified | string | Represents a filter for gifts modified on or after the specified date. The filter respects time offsets from UTC per the ISO-8601 format: 2016-05-05T17:59:31.1600745-04:00. |
|
| sort_token | string | Represents a token filter to provide the next stable-sorted list of gifts. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request. |
|
| constituent_id | array | Represents a list of constituent identifiers. Returns gifts if any of the specified constituent identifiers match any of their constituents. For example, "constituent_id=280&constituent_id=1232" returns gifts with either "280" or "1232" constituent identifiers. |
|
| post_status | array | Represents a list of gift post statuses. Returns gifts if their post status matches any specified. For example, "post_status=DoNotPost&post_status=Posted" returns gifts that are marked either DoNotPost or Posted. |
|
| gift_type | array | Represents a list of gift types. Returns gifts if their type matches any specified. For example, "gift_type=MatchingGiftPledge&gift_type=RecurringGift" returns gifts of type MatchingGiftPledge or RecurringGift. Available values are Donation, GiftInKind, MatchingGiftPledge, MatchingGiftPayment, PlannedGift, Pledge, PledgePayment, RecurringGift, RecurringGiftPayment, Stock, SoldStock, and Other. |
|
| receipt_status | array | Represents a list of gift receipt statuses. Returns gifts if their receipt status matches any specified. For example, "receipt_status=DoNotReceipt&receipt_status=Receipted" returns gifts that are marked either DoNotReceipt or Receipted. |
|
| acknowledgement_status | array | Represents a list of gift acknowledgement statuses. Returns gifts if their acknowledgement status matches any specified. For example, "acknowledgement_status=DoNotAcknowledge&acknowledgement_status=Acknowledged" returns gifts that are marked either DoNotAcknowledge or Acknowledged. |
|
| campaign_id | array | Represents a list of campaign identifiers. Returns gifts if any of the specified campaign identifiers match any of their campaigns. For example, "campaign_id=280&campaign_id=1232" returns gifts with either "280" or "1232" campaign identifiers. |
|
| fund_id | array | Represents a list of fund identifiers. Returns gifts if any of the specified fund identifiers match any of their funds. For example, "fund_id=280&fund_id=1232" returns gifts with either "280" or "1232" fund identifiers. |
|
| appeal_id | array | Represents a list of appeal identifiers. Returns gifts if any of the specified appeal identifiers match any of their appeals. For example, "appeal_id=280&appeal_id=1232" returns gifts with either "280" or "1232" appeal identifiers. |
|
| start_gift_date | string | Represents a filter for gifts with a gift date on or after the specified date. If used with end_gift_date, returns gifts with gift dates between both values. |
|
| end_gift_date | string | Represents a filter for gifts with a gift date on or before the specified date. If used with start_gift_date, returns gifts with gift dates between both values. |
|
| start_gift_amount | number | Format - double. Represents a filter for gifts with an amount greater than or equal to the specified amount. If used with end_gift_amount, returns gifts with amounts between both values. |
|
| end_gift_amount | number | Format - double. Represents a filter for gifts with an amount less than or equal to the specified amount. If used with start_gift_amount, returns gifts with amounts between both values. |
|
| list_id | string | Defines a list identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored. |
|
| sort | array | Represents a list of fields to sort the results by. Returns a list that sorts gifts based on the supplied fields. Results are in ascending order by default, and a '-' sign denotes descending order. For example, "sort=date_added,-date" sorts gifts by the "date_added" field in ascending order and then by the "gift date" field in descending order. If only the date_modified field or only the date_added field is provided, then this adds the sort_token parameter to the next_link URL to ensure that gifts are stably sorted. |
|
| limit | integer | Represents the number of records to return. The default is 500. The maximum is 5000. |
|
| offset | integer | Represents the number of records to skip. For use with pagination. |
Request headers
| Header | Required | Type | Description |
|---|---|---|---|
| Bb-Api-Subscription-Key | Property is required | string | Subscription key which provides access to this API. Found in your Profile. |
| Authorization | Property is required | string | OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code, Implicit. |
Response 200 OK
Returned when the operation succeeds. The response body contains a collection of gift entities.
| ETag | string | The entity tag of the object to be returned in an If-Match header to subject the object to a concurrency check. |
{
"count": 1304,
"next_link": "https://api.sky.blackbaud.com/gift/v1/gifts?limit=3&offset=3",
"value": [
{
"id": "492",
"acknowledgements": [
{
"status": "Acknowledged"
}
],
"amount": {
"value": 40
},
"balance": {
"value": 0
},
"batch_number": "23",
"constituent_id": "565",
"date": "2005-05-30T00:00:00Z",
"date_added": "2000-05-23T16:16:23.97Z",
"date_modified": "2017-03-15T14:00:12.554Z",
"gift_splits": [
{
"id": "1814",
"amount": {
"value": 40
},
"campaign_id": "6",
"fund_id": "12"
}
],
"gift_status": "Active",
"is_anonymous": false,
"constituency": "Board Member",
"lookup_id": "161",
"payments": [
{
"payment_method": "Cash"
}
],
"post_status": "DoNotPost",
"receipts": [
{
"amount": {
"value": 30
},
"date": "2009-07-13T00:00:00Z",
"status": "Receipted"
}
],
"reference": "Other for Remainder",
"subtype": "Membership",
"type": "Other"
},
{
"id": "1496",
"amount": {
"value": 30
},
"constituent_id": "565",
"date": "2009-07-13T00:00:00Z",
"date_added": "2006-01-10T17:54:53.437Z",
"date_modified": "2017-03-15T14:00:12.554Z",
"gift_splits": [
{
"id": "1230",
"amount": {
"value": 30
},
"campaign_id": "2",
"fund_id": "7"
}
],
"gift_status": "Active",
"is_anonymous": false,
"constituency": "Volunteer",
"lookup_id": "1130",
"post_status": "DoNotPost",
"reference": "Registration fees for Kyle Bell and Martin Schultz",
"subtype": "Membership",
"type": "Donation"
},
{
"id": "1679",
"amount": {
"value": 200
},
"batch_number": "12",
"constituent_id": "565",
"date": "2007-04-05T00:00:00Z",
"date_added": "2007-04-05T18:33:08.437Z",
"date_modified": "2017-03-15T14:00:12.554Z",
"gift_splits": [
{
"id": "1423",
"amount": {
"value": 200
},
"fund_id": "36"
}
],
"gift_status": "Active",
"is_anonymous": false,
"lookup_id": "1304",
"post_status": "NotPosted",
"post_date": "2007-04-05T00:00:00Z",
"reference": "Bell, Kyle N.",
"type": "MatchingGiftPledge"
}
]
}{
"description": "Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.",
"type": "object",
"properties": {
"count": {
"format": "int32",
"description": "The number of items available for retrieval into the collection after applying any request parameters. The <b>limit</b> and <b>offset</b> parameters do not affect the <b>count</b>, but to facilitate paging, they may affect the number of items in the <b>value</b> result set.",
"type": "integer"
},
"next_link": {
"description": "For paginated responses, the URI for the next page of results.",
"type": "string"
},
"value": {
"description": "The set of items included in the response. This may be a subset of the items in the collection.",
"type": "array",
"items": {
"description": "Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the gift.",
"type": "string"
},
"acknowledgements": {
"description": "The set of acknowledgements associated with the gift.",
"type": "array",
"items": {
"description": "Acknowledgement letters foster relationships with donors and show appreciation for their contributions. It is important to keep track of the acknowledgement status of gifts to ensure that each one gets a well-deserved thank you.",
"type": "object",
"properties": {
"date": {
"format": "date-time",
"description": "The date associated with the acknowledgement. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"letter": {
"description": "The letter associated with the acknowledgement.",
"type": "string"
},
"status": {
"description": "The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE. When using the GET Gift List endpoint, the type string for NEEDSACKNOWLEDGEMENT returns as NotAcknowledged.",
"type": "string"
}
},
"x-display-name": "Acknowledgement",
"x-display-id": "Acknowledgement"
}
},
"amount": {
"description": "The monetary amount of the gift.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"balance": {
"description": "The balance remaining on the gift.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"batch_number": {
"description": "The batch number associated with this gift.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the gift.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "The gift date. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"date_added": {
"format": "date-time",
"description": "The date when the gift was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
"type": "string",
"x-supports-datetime-offset": true
},
"date_modified": {
"format": "date-time",
"description": "The date when the gift was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
"type": "string",
"x-supports-datetime-offset": true
},
"fundraisers": {
"description": "The set of fundraisers who receive credit for the gift.",
"type": "array",
"items": {
"description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and request donations. When a constituent makes a donation, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
"type": "object",
"properties": {
"amount": {
"description": "The amount credited to the fundraiser for the gift.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"constituent_id": {
"description": "The immutable constituent system record ID for the fundraiser associated with the gift.",
"type": "string"
}
},
"x-display-name": "Gift fundraiser",
"x-display-id": "GiftFundraiser"
}
},
"gift_aid_amount": {
"description": "This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all <code>gift_splits</code> for this gift. For the UK only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"gift_aid_qualification_status": {
"description": "This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: <i>Qualified</i>, <i>NotQualified</i>, and <i>PartlyQualified</i>. For the UK only.",
"type": "string"
},
"gift_code": {
"description": "The gift code value associated with the gift.",
"type": "string"
},
"gift_splits": {
"description": "The set of gift splits associated with the gift.",
"type": "array",
"items": {
"description": "Not all gifts serve a single purpose. Gift splits track donor wishes and allow you to divide gifts among multiple campaigns, funds, and appeals.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the gift split.",
"type": "string"
},
"amount": {
"description": "The amount of the gift split.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"appeal_id": {
"description": "The immutable system record ID of the appeal associated with the gift split.",
"type": "string"
},
"campaign_id": {
"description": "The immutable system record ID of the campaign associated with the gift split.",
"type": "string"
},
"fund_id": {
"description": "The immutable system record ID of the fund associated with the gift split.",
"type": "string"
},
"gift_aid_amount": {
"description": "The amount of tax reclaimed from gift aid for this gift split. For the UK only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"gift_aid_qualification_status": {
"description": "The gift aid qualification status of the gift split. Available values are: <i>Qualified</i>, and <i>NotQualified</i>. For the UK only.",
"type": "string"
},
"package_id": {
"description": "The immutable system record ID of the package associated with the gift split.",
"type": "string"
}
},
"x-display-name": "Gift split",
"x-display-id": "GiftSplit"
}
},
"gift_status": {
"description": "The status of the gift. Available values are <i>Active</i>, <i>Held</i>, <i>Terminated</i>, <i>Completed</i>, and <i>Cancelled.</i>",
"type": "string"
},
"is_anonymous": {
"description": "Indicates whether the gift is anonymous.",
"type": "boolean"
},
"linked_gifts": {
"description": "The identifiers of other gifts that are linked to this gift.",
"type": "array",
"items": {
"type": "string"
}
},
"constituency": {
"description": "The constituency of the gift.",
"type": "string"
},
"lookup_id": {
"description": "The user-defined identifier for the gift.",
"type": "string"
},
"origin": {
"description": "The origin of the gift.",
"type": "string"
},
"payments": {
"description": "The payments on the gift.",
"type": "array",
"items": {
"description": "Donors can use a variety of methods — such as Cash, Personal check, Credit card, and Direct debit — to pay for gifts.",
"type": "object",
"properties": {
"account_token": {
"description": "The tokenized account information (e.g. credit card) from the external payment provider. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
"type": "string"
},
"bbps_configuration_id": {
"description": "The bbps configuration ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
"type": "string"
},
"bbps_transaction_id": {
"description": "The bbps transaction ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
"type": "string"
},
"check_date": {
"description": "The check date. Only applies to payment method of <i>PersonalCheck</i>.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"check_number": {
"description": "The check number. Only applies to payment method of <i>PersonalCheck</i>.",
"type": "string"
},
"checkout_transaction_id": {
"description": "The checkout transaction ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
"type": "string"
},
"payment_method": {
"description": "The payment method. Available values are listed below.",
"type": "string"
},
"reference": {
"description": "The reference. Only applies to payment method of <i>Other</i>.",
"type": "string"
},
"reference_date": {
"description": "The reference date. Only applies to payment method of <i>Other</i>.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
}
},
"x-display-name": "Payment",
"x-display-id": "Payment",
"x-additional-info": "<a name=\"PaymentMethods\"></a>\r\n<p> </p>\r\n<p>\r\n Available values for the <b>payment_method</b> of a <b>payment</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n <table class=\"table table-striped table-hover\">\r\n <thead>\r\n <tr>\r\n <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n </tr>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td>Cash</td>\r\n <td>Cash.</td>\r\n </tr>\r\n <tr>\r\n <td>PersonalCheck</td>\r\n <td>A personal check.</td>\r\n </tr>\r\n <tr>\r\n <td>CreditCard</td>\r\n <td>A credit card.</td>\r\n </tr>\r\n <tr>\r\n <td>StandingOrder</td>\r\n <td>A standing order.</td>\r\n </tr>\r\n <tr>\r\n <td>DirectDebit</td>\r\n <td>Direct debit.</td>\r\n </tr>\r\n <tr>\r\n <td>Voucher</td>\r\n <td>A voucher.</td>\r\n </tr>\r\n <tr>\r\n <td>Other</td>\r\n <td>Another method of payment.</td>\r\n </tr>\r\n <tr>\r\n <td>PayPal</td>\r\n <td>PayPal</td>\r\n </tr>\r\n <tr>\r\n <td>Venmo</td>\r\n <td>Venmo</td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>\r\n\r\n<div class=\"footnotes\">\r\n <p class=\"footnote\"><b>Note:</b> For the <i>ListGifts</i> endpoint, only <code>payment_method</code> is returned.</p>\r\n</div>"
}
},
"post_date": {
"format": "date-time",
"description": "The date that the gift was posted to general ledger. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"post_status": {
"description": "The general ledger post status of the gift. Available values are <i>Posted</i>, <i>NotPosted</i>, and <i>DoNotPost.</i> When <code>post_status</code> is set to <i>DoNotPost</i>, <code>post_date</code> should be null. When it is set to <i>NotPosted</i>, <code>post_date</code> is required but remains editable. When it is set to <i>Posted</i>, <code>post_date</code> is required and is no longer editable.",
"type": "string"
},
"receipts": {
"description": "The set of receipts associated with the gift.",
"type": "array",
"items": {
"description": "To help donors track their giving for tax purposes, your organization should provide gift receipts.",
"type": "object",
"properties": {
"amount": {
"description": "The amount of the receipt.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"date": {
"format": "date-time",
"description": "The date on the receipt. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"number": {
"format": "int32",
"description": "The number of the receipt.",
"type": "integer"
},
"status": {
"description": "The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.",
"type": "string"
}
},
"x-display-name": "Receipt",
"x-display-id": "Receipt"
}
},
"recurring_gift_schedule": {
"description": "The recurring gift schedule. Only returned for automated recurring gifts.",
"required": [
"frequency",
"start_date"
],
"type": "object",
"properties": {
"end_date": {
"format": "date-time",
"description": "Date the recurring gift should end. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"frequency": {
"description": "Installment frequency of the recurring gift to view. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.",
"type": "string"
},
"start_date": {
"format": "date-time",
"description": "Date the recurring gift should start. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"next_transaction_date": {
"format": "date-time",
"description": "The date of the next scheduled transaction. Only applies to Recurring Gifts and Pledges.",
"type": "string",
"x-supports-datetime-offset": false
}
},
"x-hidden": true,
"x-display-name": "Recurring gift schedule",
"x-display-id": "RecurringGiftSchedule"
},
"recurring_gift_status_date": {
"description": "The date that the gift status was last modified.",
"type": "object",
"properties": {
"d": {
"format": "int32",
"description": "The day in the fuzzy date.",
"type": "integer"
},
"m": {
"format": "int32",
"description": "The month in the fuzzy date.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "The year in the fuzzy date.",
"type": "integer"
}
},
"x-display-name": "Fuzzy date",
"x-display-id": "FuzzyDate"
},
"reference": {
"description": "Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.",
"type": "string"
},
"soft_credits": {
"description": "The set of soft credits associated with the gift.",
"type": "array",
"items": {
"description": "Soft credits allow you to recognize and track the indirect contributions of constituents such as spouses who influence the gifts of other constituents.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the soft credit.",
"type": "string"
},
"amount": {
"description": "The amount of the soft credit.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the soft credit.",
"type": "string"
},
"gift_id": {
"description": "The immutable system record ID of the gift associated with the soft credit.",
"type": "string"
}
},
"x-display-name": "Soft credit",
"x-display-id": "SoftCredit"
}
},
"subtype": {
"description": "The subtype of the gift. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/ListGiftSubtypes\"><b>Gift Subtypes</b></a> table.",
"type": "string"
},
"type": {
"description": "The gift type. Available values are listed below.",
"type": "string"
}
},
"x-display-name": "Gift",
"x-display-id": "Gift",
"x-additional-info": "<a name=\"GiftTypes\"></a>\r\n<p> </p>\r\n<p>\r\n Available values for the <b>type</b> of a <b>gift</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n <table class=\"table table-striped table-hover\">\r\n <thead>\r\n <tr>\r\n <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n </tr>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td>Amendment</td>\r\n <td>An amendment.</td>\r\n </tr>\r\n <tr>\r\n <td>Donation</td>\r\n <td>A donation.</td>\r\n </tr>\r\n <tr>\r\n <td>GiftInKind</td>\r\n <td>A gift-in-kind.</td>\r\n </tr>\r\n <tr>\r\n <td>GeneralLedgerReversal</td>\r\n <td>A general ledger reversal.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftPledge</td>\r\n <td>A matching gift pledge.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftPayment</td>\r\n <td>A matching gift payment.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftWriteOff</td>\r\n <td>A matching gift write-off.</td>\r\n </tr>\r\n <tr>\r\n <td>PlannedGift</td>\r\n <td>A planned gift.</td>\r\n </tr>\r\n <tr>\r\n <td>Pledge</td>\r\n <td>A pledge.</td>\r\n </tr>\r\n <tr>\r\n <td>PledgePayment</td>\r\n <td>A pledge payment.</td>\r\n </tr>\r\n <tr>\r\n <td>PledgeWriteOff</td>\r\n <td>A pledge write off.</td>\r\n </tr>\r\n <tr>\r\n <td>RecurringGift</td>\r\n <td>A recurring gift.</td>\r\n </tr>\r\n <tr>\r\n <td>RecurringGiftPayment</td>\r\n <td>A recurring gift payment.</td>\r\n </tr>\r\n <tr>\r\n <td>Stock</td>\r\n <td>A stock.</td>\r\n </tr>\r\n <tr>\r\n <td>SoldStock</td>\r\n <td>A sold stock.</td>\r\n </tr>\r\n <tr>\r\n <td>Other</td>\r\n <td>Another type of gift.</td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 400 Bad Request
Returned when the specified request parameters are not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to view the gifts.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/gift/v1/gifts?date_added={string}&last_modified={string}&sort_token={string}&constituent_id={array}&post_status={array}&gift_type={array}&receipt_status={array}&acknowledgement_status={array}&campaign_id={array}&fund_id={array}&appeal_id={array}&start_gift_date={string}&end_gift_date={string}&start_gift_amount={number}&end_gift_amount={number}&list_id={string}&sort={array}&limit={integer}&offset={integer}"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");
// Request parameters
queryString["date_added"] = "{string}";
queryString["last_modified"] = "{string}";
queryString["sort_token"] = "{string}";
queryString["constituent_id"] = "{array}";
queryString["post_status"] = "{array}";
queryString["gift_type"] = "{array}";
queryString["receipt_status"] = "{array}";
queryString["acknowledgement_status"] = "{array}";
queryString["campaign_id"] = "{array}";
queryString["fund_id"] = "{array}";
queryString["appeal_id"] = "{array}";
queryString["start_gift_date"] = "{string}";
queryString["end_gift_date"] = "{string}";
queryString["start_gift_amount"] = "{number}";
queryString["end_gift_amount"] = "{number}";
queryString["list_id"] = "{string}";
queryString["sort"] = "{array}";
queryString["limit"] = "{integer}";
queryString["offset"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/gift/v1/gifts?" + queryString;
var response = await client.GetAsync(uri);
}
}
}// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/gift/v1/gifts");
builder.setParameter("date_added", "{string}");
builder.setParameter("last_modified", "{string}");
builder.setParameter("sort_token", "{string}");
builder.setParameter("constituent_id", "{array}");
builder.setParameter("post_status", "{array}");
builder.setParameter("gift_type", "{array}");
builder.setParameter("receipt_status", "{array}");
builder.setParameter("acknowledgement_status", "{array}");
builder.setParameter("campaign_id", "{array}");
builder.setParameter("fund_id", "{array}");
builder.setParameter("appeal_id", "{array}");
builder.setParameter("start_gift_date", "{string}");
builder.setParameter("end_gift_date", "{string}");
builder.setParameter("start_gift_amount", "{number}");
builder.setParameter("end_gift_amount", "{number}");
builder.setParameter("list_id", "{string}");
builder.setParameter("sort", "{array}");
builder.setParameter("limit", "{integer}");
builder.setParameter("offset", "{integer}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "Bearer {access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"date_added": "{string}",
"last_modified": "{string}",
"sort_token": "{string}",
"constituent_id": "{array}",
"post_status": "{array}",
"gift_type": "{array}",
"receipt_status": "{array}",
"acknowledgement_status": "{array}",
"campaign_id": "{array}",
"fund_id": "{array}",
"appeal_id": "{array}",
"start_gift_date": "{string}",
"end_gift_date": "{string}",
"start_gift_amount": "{number}",
"end_gift_amount": "{number}",
"list_id": "{string}",
"sort": "{array}",
"limit": "{integer}",
"offset": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/gift/v1/gifts?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.sky.blackbaud.com/gift/v1/gifts";
NSArray* array = @[
// Request parameters
@"entities=true",
@"date_added={string}",
@"last_modified={string}",
@"sort_token={string}",
@"constituent_id={array}",
@"post_status={array}",
@"gift_type={array}",
@"receipt_status={array}",
@"acknowledgement_status={array}",
@"campaign_id={array}",
@"fund_id={array}",
@"appeal_id={array}",
@"start_gift_date={string}",
@"end_gift_date={string}",
@"start_gift_amount={number}",
@"end_gift_amount={number}",
@"list_id={string}",
@"sort={array}",
@"limit={integer}",
@"offset={integer}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Bb-Api-Subscription-Key"];
[_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.sky.blackbaud.com/gift/v1/gifts');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'date_added' => '{string}',
'last_modified' => '{string}',
'sort_token' => '{string}',
'constituent_id' => '{array}',
'post_status' => '{array}',
'gift_type' => '{array}',
'receipt_status' => '{array}',
'acknowledgement_status' => '{array}',
'campaign_id' => '{array}',
'fund_id' => '{array}',
'appeal_id' => '{array}',
'start_gift_date' => '{string}',
'end_gift_date' => '{string}',
'start_gift_amount' => '{number}',
'end_gift_amount' => '{number}',
'list_id' => '{string}',
'sort' => '{array}',
'limit' => '{integer}',
'offset' => '{integer}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.urlencode({
# Request parameters
'date_added': '{string}',
'last_modified': '{string}',
'sort_token': '{string}',
'constituent_id': '{array}',
'post_status': '{array}',
'gift_type': '{array}',
'receipt_status': '{array}',
'acknowledgement_status': '{array}',
'campaign_id': '{array}',
'fund_id': '{array}',
'appeal_id': '{array}',
'start_gift_date': '{string}',
'end_gift_date': '{string}',
'start_gift_amount': '{number}',
'end_gift_amount': '{number}',
'list_id': '{string}',
'sort': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/gift/v1/gifts?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'date_added': '{string}',
'last_modified': '{string}',
'sort_token': '{string}',
'constituent_id': '{array}',
'post_status': '{array}',
'gift_type': '{array}',
'receipt_status': '{array}',
'acknowledgement_status': '{array}',
'campaign_id': '{array}',
'fund_id': '{array}',
'appeal_id': '{array}',
'start_gift_date': '{string}',
'end_gift_date': '{string}',
'start_gift_amount': '{number}',
'end_gift_amount': '{number}',
'list_id': '{string}',
'sort': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/gift/v1/gifts?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.sky.blackbaud.com/gift/v1/gifts')
query = URI.encode_www_form({
# Request parameters
'date_added' => '{string}',
'last_modified' => '{string}',
'sort_token' => '{string}',
'constituent_id' => '{array}',
'post_status' => '{array}',
'gift_type' => '{array}',
'receipt_status' => '{array}',
'acknowledgement_status' => '{array}',
'campaign_id' => '{array}',
'fund_id' => '{array}',
'appeal_id' => '{array}',
'start_gift_date' => '{string}',
'end_gift_date' => '{string}',
'start_gift_amount' => '{number}',
'end_gift_amount' => '{number}',
'list_id' => '{string}',
'sort' => '{array}',
'limit' => '{integer}',
'offset' => '{integer}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body
Comments