Constituent

This API manages constituent information and related entities such as addresses, phones, emails, and notes.

GET

Constituent list

Returns a paginated list of constituents.

The default sorting behavior is to list constituents in ascending alphabetical order based on the full name of organizations and the last name of individuals. However, some parameters override the default sorting behavior. The sort parameter sorts based on the fields that it specifies, and the sort_token parameter sorts based on the next stable-sorted list of results. (These parameters cannot be provided together.) If the sort and sort_token parameters are not provided, then the last_modified parameter sorts constituents in ascending order based on when they were last modified and the date_added parameter sorts constituents in ascending order based on when they were created. (If the last_modified and date_added parameters are both specified, sorting is based on the last-modified date.)

Some parameters also add the sort_token parameter to the next_link URL to ensure that constituents are stably sorted and that the order persists even if changes occur while working through a paginated list. The last_modified, date_added, and sort parameters all add the sort_token parameter to the next_link URL, although the sort parameter only adds the sort_token parameter when it sorts by just the date_added field or just the date_modified field.

Note: This endpoint returns data with an average latency of about 30 minutes.

Try it

Request URL

Request parameters

Parameter Required Type Description
constituent_code array

Represents a list of constituent codes. Returns constituents if any of the specified constituent codes match any of their active constituent codes. For example, "constituent_code=Board Member&constituent_code=Volunteer" returns constituents with either "Board Member" or "Volunteer" constituent codes.

constituent_id array

Represents a list of constituent identifiers. Returns constituents if any of the specified constituent identifiers match any of their constituents. For example, "constituent_id=280&constituent_id=1232" returns constituents with either "280" or "1232" constituent identifiers.

custom_field_category array

Represents a list of custom field categories. Returns constituents if any of the specified custom field categories match any of their active custom fields. For example, "custom_field_category=Interests&custom_field_category=Anniversary" returns constituents with either "Interests" or "Anniversary" custom fields.

fields array

Represents the fields to include on the returned records. For example, "fields=id,first,last,deceased_date". The id field will always be returned.

fundraiser_status array

Represents a comma-separated list of fundraiser statuses. Returns constituents if any of the specified fundraiser statuses match the constituent's fundraiser status. For example, "fundrasier_status=Active,None" returns constituents whose fundraiser status that matches Active or None. Valid values for this filter are Active, Inactive, and None.

include_deceased boolean

Set this parameter to "true" to include deceased constituents in the response.

include_inactive boolean

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

postal_code array

Represents a comma-separated list of postal codes. Returns constituents if any of the specified postal codes match the postal code for their preferred address. For example, "postal_code=99577,14623" returns constituents whose preferred address has a postal code that matches or starts with 99577 or 14623, such as 99577, 14623, or 99577-0727.

date_added string

Represents a filter for results created on or after the specified date. Adds the sort_token parameter to the next_link URL to ensure that constituents are stably sorted. 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 results modified on or after the specified date. Adds the sort_token parameter to the next_link URL to ensure that constituents are stably sorted. 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 results and to ensure that the order persists even if changes occur while working through a paginated list. The token is provided on the next_link collection response property when the request specifies the sort_token filter. The last_modified, date_added, and sort parameters also add the token to the next_link URL, although the sort parameter only adds the token when it sorts by just the date_added field or just the date_modified field.

sort array

Represents a list of fields to sort the results by. Returns a list that sorts constituents based on the supplied fields. Results are in ascending order by default, and a '-' sign denotes descending order. For example, "sort=date_added,-last" sorts constituents by the "date_added" field in ascending order and then by the "last" 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 constituents 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 constituent entities.

{
  "count": 241,
  "next_link": "https://api.sky.blackbaud.com/constituent/v1/constituents?limit=3&last_modified=2016-05-05T17%3a59%3a31.1600745-04%3a00&sort_token=AAAAAAAC%2bI4%3d",
  "value": [
    {
      "id": "187",
      "address": {
        "id": "279",
        "address_lines": "125 Smokerise Way",
        "city": "Charleston",
        "constituent_id": "187",
        "country": "United States",
        "county": "Charleston",
        "formatted_address": "125 Smokerise Way\r\nCharleston, SC  29401",
        "inactive": false,
        "postal_code": "29401",
        "preferred": true,
        "state": "SC"
      },
      "age": 61,
      "birthdate": {
        "d": 23,
        "m": 9,
        "y": 1954
      },
      "date_added": "2008-05-19T14:45:09.04+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00",
      "deceased": false,
      "email": {
        "id": "973",
        "address": "madamson@sncn.net",
        "constituent_id": "187",
        "do_not_email": false,
        "inactive": false,
        "primary": false,
        "type": "Email"
      },
      "first": "Mark",
      "fundraiser_status": "Active",
      "gender": "Male",
      "gives_anonymously": true,
      "inactive": false,
      "last": "Adamson",
      "lookup_id": "3",
      "middle": "Daniel",
      "name": "Mr. Mark D. Adamson, III",
      "phone": {
        "id": "4",
        "constituent_id": "187",
        "do_not_call": false,
        "inactive": false,
        "number": "843-798-6698",
        "primary": false,
        "type": "Home"
      },
      "suffix": ", III",
      "title": "Mr.",
      "type": "Individual"
    },
    {
      "id": "280",
      "address": {
        "id": "687",
        "address_lines": "410 17th Street",
        "city": "Denver",
        "constituent_id": "280",
        "country": "United States",
        "county": "Denver",
        "formatted_address": "410 17th Street\r\nDenver, CO  80202-4402",
        "inactive": false,
        "postal_code": "80202-4402",
        "preferred": true,
        "state": "CO"
      },
      "age": 54,
      "birthdate": {
        "d": 14,
        "m": 3,
        "y": 1961
      },
      "date_added": "2000-04-26T15:26:45.977+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00",
      "deceased": false,
      "email": {
        "id": "283",
        "address": "robertcarloshernandez@gmail.com",
        "constituent_id": "280",
        "do_not_email": false,
        "inactive": false,
        "primary": false,
        "type": "Email"
      },
      "first": "Robert",
      "fundraiser_status": "Active",
      "gender": "Male",
      "inactive": false,
      "last": "Hernandez",
      "lookup_id": "96",
      "middle": "Carlos",
      "name": "Dr. Robert C. Hernandez",
      "online_presence": {
        "id": "811",
        "address": "http://www.myspace.com/drbobhernandez",
        "constituent_id": "280",
        "inactive": false,
        "primary": false,
        "type": "Web address"
      },
      "phone": {
        "id": "95",
        "constituent_id": "280",
        "do_not_call": false,
        "inactive": false,
        "number": "(303)-997-3301",
        "primary": false,
        "type": "Home"
      },
      "preferred_name": "Bob",
      "spouse": {
        "id": "410",
        "first": "Wendy",
        "last": "Hernandez"
      },
      "title": "Dr.",
      "type": "Individual"
    },
    {
      "id": "410",
      "address": {
        "id": "687",
        "address_lines": "410 17th Street",
        "city": "Denver",
        "country": "United States",
        "county": "Denver",
        "formatted_address": "410 17th Street\r\nDenver, CO  80202-4402",
        "inactive": false,
        "postal_code": "80202-4402",
        "preferred": true,
        "state": "CO"
      },
      "age": 53,
      "birthdate": {
        "d": 11,
        "m": 12,
        "y": 1962
      },
      "date_added": "2000-04-26T16:00:04.51+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00",
      "deceased": false,
      "email": {
        "id": "1196",
        "address": "wendycorizonhernandez@gmail.com",
        "do_not_email": false,
        "inactive": false,
        "primary": false,
        "type": "Email"
      },
      "first": "Wendy",
      "fundraiser_status": "None",
      "gender": "Female",
      "inactive": false,
      "last": "Hernandez",
      "phone": {
        "id": "1510",
        "do_not_call": false,
        "inactive": false,
        "number": "(303)-997-3301",
        "primary": false,
        "type": "Home"
      },
      "spouse": {
        "id": "280",
        "first": "Robert",
        "last": "Hernandez"
      },
      "title": "Mrs.",
      "type": "Individual"
    }
  ]
}

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 constituents.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents?constituent_code={array}&constituent_id={array}&custom_field_category={array}&fields={array}&fundraiser_status={array}&include_deceased={boolean}&include_inactive={boolean}&postal_code={array}&date_added={string}&last_modified={string}&sort_token={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["constituent_code"] = "{array}";
            queryString["constituent_id"] = "{array}";
            queryString["custom_field_category"] = "{array}";
            queryString["fields"] = "{array}";
            queryString["fundraiser_status"] = "{array}";
            queryString["include_deceased"] = "{boolean}";
            queryString["include_inactive"] = "{boolean}";
            queryString["postal_code"] = "{array}";
            queryString["date_added"] = "{string}";
            queryString["last_modified"] = "{string}";
            queryString["sort_token"] = "{string}";
            queryString["sort"] = "{array}";
            queryString["limit"] = "{integer}";
            queryString["offset"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents?" + 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/constituent/v1/constituents");

            builder.setParameter("constituent_code", "{array}");
            builder.setParameter("constituent_id", "{array}");
            builder.setParameter("custom_field_category", "{array}");
            builder.setParameter("fields", "{array}");
            builder.setParameter("fundraiser_status", "{array}");
            builder.setParameter("include_deceased", "{boolean}");
            builder.setParameter("include_inactive", "{boolean}");
            builder.setParameter("postal_code", "{array}");
            builder.setParameter("date_added", "{string}");
            builder.setParameter("last_modified", "{string}");
            builder.setParameter("sort_token", "{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
            "constituent_code": "{array}",
            "constituent_id": "{array}",
            "custom_field_category": "{array}",
            "fields": "{array}",
            "fundraiser_status": "{array}",
            "include_deceased": "{boolean}",
            "include_inactive": "{boolean}",
            "postal_code": "{array}",
            "date_added": "{string}",
            "last_modified": "{string}",
            "sort_token": "{string}",
            "sort": "{array}",
            "limit": "{integer}",
            "offset": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/constituent/v1/constituents?" + $.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/constituent/v1/constituents";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"constituent_code={array}",
                         @"constituent_id={array}",
                         @"custom_field_category={array}",
                         @"fields={array}",
                         @"fundraiser_status={array}",
                         @"include_deceased={boolean}",
                         @"include_inactive={boolean}",
                         @"postal_code={array}",
                         @"date_added={string}",
                         @"last_modified={string}",
                         @"sort_token={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/constituent/v1/constituents');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'constituent_code' => '{array}',
    'constituent_id' => '{array}',
    'custom_field_category' => '{array}',
    'fields' => '{array}',
    'fundraiser_status' => '{array}',
    'include_deceased' => '{boolean}',
    'include_inactive' => '{boolean}',
    'postal_code' => '{array}',
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{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
    'constituent_code': '{array}',
    'constituent_id': '{array}',
    'custom_field_category': '{array}',
    'fields': '{array}',
    'fundraiser_status': '{array}',
    'include_deceased': '{boolean}',
    'include_inactive': '{boolean}',
    'postal_code': '{array}',
    'date_added': '{string}',
    'last_modified': '{string}',
    'sort_token': '{string}',
    'sort': '{array}',
    'limit': '{integer}',
    'offset': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/constituent/v1/constituents?%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
    'constituent_code': '{array}',
    'constituent_id': '{array}',
    'custom_field_category': '{array}',
    'fields': '{array}',
    'fundraiser_status': '{array}',
    'include_deceased': '{boolean}',
    'include_inactive': '{boolean}',
    'postal_code': '{array}',
    'date_added': '{string}',
    'last_modified': '{string}',
    'sort_token': '{string}',
    'sort': '{array}',
    'limit': '{integer}',
    'offset': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'constituent_code' => '{array}',
    'constituent_id' => '{array}',
    'custom_field_category' => '{array}',
    'fields' => '{array}',
    'fundraiser_status' => '{array}',
    'include_deceased' => '{boolean}',
    'include_inactive' => '{boolean}',
    'postal_code' => '{array}',
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{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

Have a question? See a problem with our docs? Want to engage with the SKY API team? Please visit us on the SKY API Community!