Constituent

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

GET Address list (All constituents)

Returns a paginated list of addresses.

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

However, the last_modified parameter overrides the default sorting behavior to list addresses 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 addresses 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 addresses 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

date_added string

Represents a filter for addresses 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 addresses 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 addresses. 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 addresses 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 address entities.

{
  "count": 774,
  "next_link": "https://api.sky.blackbaud.com/constituent/v1/addresses?offset=4&limit=4",
  "value": [
    {
      "id": "184",
      "constituent_id": "185",
      "type": "Home",
      "preferred": true,
      "inactive": false,
      "start": "2003-03-26T00:00:00",
      "end": "2025-03-26T00:00:00",
      "seasonal_start": {
        "m": 6,
        "d": 12
      },
      "seasonal_end": {
        "m": 8,
        "d": 26
      },
      "do_not_mail": false,
      "address_lines": "248 Twin Lane\r\nBuilding #3299",
      "city": "Birmingham",
      "state": "AL",
      "postal_code": "35220",
      "county": "Bailey",
      "country": "United States",
      "date_added": "1999-05-20T18:52:54+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00"
    },
    {
      "id": "185",
      "constituent_id": "186",
      "type": "Home",
      "preferred": true,
      "inactive": false,
      "start": "2001-02-26T00:00:00",
      "seasonal_start": {
        "m": 6,
        "d": 12
      },
      "seasonal_end": {
        "m": 8,
        "d": 26
      },
      "do_not_mail": false,
      "address_lines": "2457 Morrison Drive",
      "city": "Savannah",
      "state": "GA",
      "postal_code": "31406",
      "country": "United States",
      "date_added": "1999-05-20T18:52:55+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00"
    },
    {
      "id": "186",
      "constituent_id": "187",
      "type": "Home",
      "preferred": true,
      "inactive": false,
      "start": "1994-03-26T00:00:00",
      "do_not_mail": false,
      "address_lines": "125 Smokerise Way",
      "city": "Charleston",
      "state": "SC",
      "postal_code": "29401",
      "county": "Charleston",
      "country": "United States",
      "date_added": "1999-05-20T18:52:55+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00"
    },
    {
      "id": "187",
      "constituent_id": "188",
      "type": "Home",
      "preferred": true,
      "inactive": false,
      "do_not_mail": false,
      "address_lines": "4859 Philpot Lane",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55403",
      "country": "United States",
      "date_added": "1999-05-20T18:52:56+00:00",
      "date_modified": "2016-10-19T19:42:38.775+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": "Defines the shape of a constituent address record",
        "type": "object",
        "properties": {
          "id": {
            "description": "The address identifier.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The constituent identifier.",
            "type": "string"
          },
          "type": {
            "description": "The address type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/5744a7efd7dcde29b07a4d8e\"><b>Address Types</b></a> table.",
            "type": "string"
          },
          "formatted_address": {
            "description": "This computed field retrieves the formatted address in the configured format of the country.",
            "type": "string"
          },
          "preferred": {
            "description": "Indicates whether this is the constituent's preferred address.",
            "type": "boolean"
          },
          "inactive": {
            "description": "This computed field indicates that the address is active if the current date is before any <code>end</code> date.",
            "type": "boolean"
          },
          "start": {
            "format": "date-time",
            "description": "The date when the constituent began residing at this address. 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
          },
          "end": {
            "format": "date-time",
            "description": "The date when the constituent ceased to reside at this address. 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
          },
          "seasonal_start": {
            "description": "The time of year that the constituent begins residing at this address.",
            "type": "object",
            "properties": {
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date"
          },
          "seasonal_end": {
            "description": "The time of the year ceases to reside at this address.",
            "type": "object",
            "properties": {
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date"
          },
          "do_not_mail": {
            "description": "Indicates whether the constituent requests not to be contacted at this address.",
            "type": "boolean"
          },
          "address_lines": {
            "description": "The address lines.",
            "type": "string"
          },
          "city": {
            "description": "The city of the address.",
            "type": "string"
          },
          "suburb": {
            "description": "The suburb of the address.",
            "type": "string"
          },
          "county": {
            "description": "The county of the address.",
            "type": "string"
          },
          "state": {
            "description": "The state of the address.",
            "type": "string"
          },
          "postal_code": {
            "description": "The postal code of the address.",
            "type": "string"
          },
          "country": {
            "description": "The country of the address.",
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the address 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": false
          },
          "date_modified": {
            "format": "date-time",
            "description": "The date when the address 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": false
          }
        },
        "x-display-name": "Address",
        "x-additional-info": "\r\n<p>Some <b>Address</b> entity properties include international address support.</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><strong>Property</strong></th>\r\n                <th><strong>United States</strong></th>\r\n                <th><strong>Canada</strong></th>\r\n                <th><strong>United Kingdom</strong></th>\r\n                <th><strong>Australia</strong></th>\r\n                <th><strong>New Zealand</strong></th>\r\n            </tr>\r\n        </thead>\r\n        <tbody>\r\n            <tr>\r\n                <td>address_lines</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>city</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>*</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>suburb</td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>state</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>!</td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>postal_code</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>county</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>country</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></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>Australia</b> &mdash; For <code>GET</code> operations, the <code>city</code> property returns city or suburb data. For <code>POST</code> and <code>PATCH</code> operations, you can use either the <code>suburb</code> or <code>city</code> properties, but not both. An error occurs if you provide values for both properties.</p>\r\n    <p class=\"footnote\">! <b>Canada</b> &mdash; Use the <code>state</code> property to track provinces.</p>\r\n</div>"
      }
    }
  },
  "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 addresses.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/addresses?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/constituent/v1/addresses?" + 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/addresses");

            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/constituent/v1/addresses?" + $.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/addresses";
    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/constituent/v1/addresses');
$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", "/constituent/v1/addresses?%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", "/constituent/v1/addresses?%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/addresses')

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