Fundraising (Beta)

This API manages information contained within the fundraising hierarchy and related entities such as campaigns, funds, and appeals.

GET Appeal list

Returns a paginated list of appeals.

The default sorting behavior is to list appeals in ascending order based on when they were created.

However, the last_modified parameter overrides the default sorting behavior to list appeals in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that appeals 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 appeals based on when they were last modified.

Try it

Request URL

Request parameters

date_added string

Represents a filter for appeals 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 appeals 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 appeals. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request.

include_inactive boolean

Set this parameter to "true" to include inactive appeals in the response.

limit integer

Represents the number of records to return. The default is 500.

offset integer

Represents the number of records to skip. For use with pagination.

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 a collection of appeal entities.

{
  "count": 23,
  "next_link": "https://api.sky.blackbaud.com/fundraising/v1/appeals?offset=3&limit=3",
  "value": [
    {
      "id": "1",
      "description": "Annual Newsletter",
      "lookup_id": "NEWSLETTER",
      "goal": {
        "value": 250000
      },
      "inactive": false,
      "date_added": "1999-06-25T11:59:57+00:00",
      "date_modified": "2007-06-18T14:44:52.623+00:00"
    },
    {
      "id": "2",
      "description": "Celebrity Auction",
      "lookup_id": "AUCTION",
      "start_date": "2004-01-01T00:00:00",
      "end_date": "2004-12-31T00:00:00",
      "goal": {
        "value": 100000
      },
      "inactive": false,
      "date_added": "1999-05-19T15:18:25+00:00",
      "date_modified": "2007-06-18T14:40:31.863+00:00"
    },
    {
      "id": "3",
      "description": "Year End Appeal",
      "lookup_id": "YEAREND",
      "goal": {
        "value": 500000
      },
      "inactive": false,
      "date_added": "1999-06-25T12:04:15+00:00",
      "date_modified": "2007-06-18T13:58:06.237+00:00"
    }
  ]
}
{
  "description": "Represents a collection of items",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of items in the collection.",
      "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": "Represents the Appeal entity",
        "type": "object",
        "properties": {
          "id": {
            "description": "The appeal identifier.",
            "type": "string"
          },
          "description": {
            "description": "The display name of the appeal.",
            "type": "string"
          },
          "lookup_id": {
            "description": "The user-defined identifier for the appeal.",
            "type": "string"
          },
          "start_date": {
            "format": "date-time",
            "description": "The start date of the appeal. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "type": "string"
          },
          "end_date": {
            "format": "date-time",
            "description": "The end date of the appeal. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-12-25T10:29:43</i>.",
            "type": "string"
          },
          "inactive": {
            "description": "This computed field indicates that the appeal is active if the current date is after any <code>start_date</code> and before any <code>end_date</code>.",
            "type": "boolean"
          },
          "goal": {
            "description": "The monetary goal associated with the appeal.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the appeal 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 appeal 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-hidden": true,
  "x-base-type": "#/definitions/Collection"
}

Response 400

Returned when the specified request parameters are not in the appropriate format.

Response 403

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

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/fundraising/v1/appeals?date_added={string}&last_modified={string}&sort_token={string}&include_inactive={boolean}&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["include_inactive"] = "{boolean}";
            queryString["limit"] = "{integer}";
            queryString["offset"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/fundraising/v1/appeals?" + 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/fundraising/v1/appeals");

            builder.setParameter("date_added", "{string}");
            builder.setParameter("last_modified", "{string}");
            builder.setParameter("sort_token", "{string}");
            builder.setParameter("include_inactive", "{boolean}");
            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}",
            "include_inactive": "{boolean}",
            "limit": "{integer}",
            "offset": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/fundraising/v1/appeals?" + $.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/fundraising/v1/appeals";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"date_added={string}",
                         @"last_modified={string}",
                         @"sort_token={string}",
                         @"include_inactive={boolean}",
                         @"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/fundraising/v1/appeals');
$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}',
    'include_inactive' => '{boolean}',
    '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}',
    'include_inactive': '{boolean}',
    'limit': '{integer}',
    'offset': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/fundraising/v1/appeals?%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}',
    'include_inactive': '{boolean}',
    'limit': '{integer}',
    'offset': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{string}',
    'include_inactive' => '{boolean}',
    '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