Gift (Beta)

This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.

GET Gift

Returns information about a gift.

Try it

Request URL

Request parameters

gift_id Property is required string

The ID of the gift to retrieve information for.

Request headers

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

Returned when the operation succeeds. The response body contains the specified gift entity.

{
  "id": "1140",
  "lookup_id": "800",
  "date": "2009-03-12T04:00:00+00:00",
  "amount": {
    "value": 250
  },
  "type": "Donation",
  "constituent_id": "190",
  "is_anonymous": false,
  "gift_splits": [
    {
      "fund_id": "25",
      "amount": {
        "value": 250
      },
      "campaign_id": "4",
      "appeal_id": "26"
    }
  ],
  "fundraisers": [
    {
      "amount": {
        "value": 250
      },
      "constituent_id": "236"
    }
  ],
  "post_status": "NotPosted",
  "post_date": "2009-03-12T04:00:00+00:00",
  "gift_status": "Active",
  "date_added": "2002-03-12T15:01:44.227+00:00",
  "date_modified": "2017-03-15T14:00:12.554+00:00"
}
{
  "description": "Represents the Gift entity",
  "type": "object",
  "properties": {
    "id": {
      "description": "The gift identifier.",
      "type": "string"
    },
    "lookup_id": {
      "description": "The user-defined identifier for the gift.",
      "type": "string"
    },
    "date": {
      "format": "date-time",
      "description": "The gift date. 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"
    },
    "amount": {
      "description": "The monetary amount of the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "type": {
      "description": "The gift type. Available values <a href=\"#GiftTypes\">are listed below</a>.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The constituent identifier.",
      "type": "string"
    },
    "is_anonymous": {
      "description": "Indicates whether the gift is anonymous.",
      "type": "boolean"
    },
    "gift_splits": {
      "description": "The set of gift splits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Represents the Gift Split entity\r\nA gift split is the distribution of the total amount of a gift among multiple campaigns, funds, and/or appeals.",
        "type": "object",
        "properties": {
          "fund_id": {
            "description": "The identifier of the fund associated with 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"
              }
            }
          },
          "campaign_id": {
            "description": "The identifier of the campaign associated with the gift split.",
            "type": "string"
          },
          "appeal_id": {
            "description": "The identifier of the appeal 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>, <i>notqualified</i>, and <i>partlyqualified</i>. For the UK only.",
            "type": "string"
          }
        },
        "x-display-name": "Gift split"
      }
    },
    "subtype": {
      "description": "The subtype of the gift. Available values are the entries in the <b>Gift Subtypes</b> table.",
      "type": "string"
    },
    "soft_credits": {
      "description": "The set of soft credits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Represents the soft credit entity\r\nA soft credit is a way to share the credit for a gift with other individuals such as friends or spouses.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount of the soft credit.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The constituent identifier.",
            "type": "string"
          },
          "id": {
            "description": "The soft credit identifier.",
            "type": "string"
          },
          "gift_id": {
            "description": "The gift identifier.",
            "type": "string"
          }
        },
        "x-display-name": "Soft credit"
      }
    },
    "fundraisers": {
      "description": "The set of fundraisers who receive credit for the gift.",
      "type": "array",
      "items": {
        "description": "Represents the Gift Fundraiser entity",
        "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 constituent identifier.",
            "type": "string"
          }
        },
        "x-display-name": "Gift fundraiser"
      }
    },
    "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>, then <code>post_date</code> should be null. When it is set to <i>notposted</i>, then <code>post_date</code> is editable. When it is set to <i>posted</i>, then <code>post_date</code> must be set and is no longer editable.",
      "type": "string"
    },
    "post_date": {
      "format": "date-time",
      "description": "The date that the gift was posted to general ledger. 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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "payments": {
      "description": "The payments on the gift.",
      "type": "array",
      "items": {
        "description": "Represents the Payment entity",
        "type": "object",
        "properties": {
          "payment_method": {
            "description": "The payment method. Available values <a href=\"#PaymentMethods\">are listed below</a>.",
            "type": "string"
          }
        },
        "x-display-name": "Payment",
        "x-additional-info": "<a id=\"PaymentMethods\"></a>\r\n<p>&nbsp;</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>businesscheck</td>\r\n                <td>A business 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        </tbody>\r\n    </table>\r\n</div>"
      }
    },
    "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"
    },
    "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-display-name": "Gift",
  "x-additional-info": "<a id=\"GiftTypes\"></a>\r\n<p>&nbsp;</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>"
}

Response 400

Returned when the specified gift ID in the request URL is not in the appropriate format.

Response 403

Returned when the user does not have permission to view the gift.

Response 404

Returned when the specified gift is not found.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}"
-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}");

            var uri = "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}?" + 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/{gift_id}");


            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
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}?" + $.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/{gift_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    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/{gift_id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'bb-api-subscription-key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/gift/v1/gifts/{gift_id}?%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({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/gift/v1/gifts/{gift_id}?%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/{gift_id}')

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