Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| constituent_id | Property is required | string | The immutable system record ID of the constituent to retrieve the addresses for. |
| include_inactive | boolean | Set this parameter to "true" to include inactive addresses in the response. |
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. |
Response 200 OK
Returned when the operation succeeds. The response body contains a collection of address entities.
{
"count": 4,
"value": [
{
"id": "757",
"address_lines": "410 17th Street",
"city": "Denver",
"constituent_id": "280",
"country": "United States",
"county": "Denver",
"do_not_mail": false,
"end": "2025-03-26T00:00:00Z",
"formatted_address": "410 17th Street\r\nDenver, CO 80202-4402",
"inactive": false,
"postal_code": "80202-4402",
"preferred": true,
"seasonal_end": {
"d": 26,
"m": 8
},
"seasonal_start": {
"d": 12,
"m": 6
},
"start": "2003-03-26T00:00:00Z",
"state": "CO",
"type": "Home"
},
{
"id": "411",
"address_lines": "102 Liberty Avenue",
"city": "Chicago",
"constituent_id": "280",
"country": "United States",
"do_not_mail": false,
"formatted_address": "102 Liberty Avenue\r\nChicago, IL 60610",
"inactive": false,
"postal_code": "60610",
"preferred": false,
"start": "1994-03-26T00:00:00Z",
"state": "IL",
"type": "Business"
},
{
"id": "582",
"address_lines": "962 Cactus Point",
"city": "Sedona",
"constituent_id": "280",
"country": "United States",
"do_not_mail": false,
"end": "2004-03-26T00:00:00Z",
"formatted_address": "962 Cactus Point\r\nSedona, AZ 86336",
"inactive": true,
"postal_code": "86336",
"preferred": false,
"seasonal_end": {
"d": 30,
"m": 12
},
"seasonal_start": {
"d": 1,
"m": 1
},
"start": "2003-03-26T00:00:00Z",
"state": "AZ",
"type": "Vacation Home"
},
{
"id": "738",
"address_lines": "27 Parkview Road",
"city": "Manchester",
"constituent_id": "280",
"country": "United States",
"do_not_mail": false,
"formatted_address": "27 Parkview Road\r\nManchester, NH 03109",
"inactive": false,
"postal_code": "03109",
"preferred": false,
"state": "NH",
"type": "Shipping"
}
]
}{
"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": "Addresses store information about constituent residences and other addresses along with information about where, how, and whether to send mail.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the address.",
"type": "string"
},
"address_lines": {
"description": "The address lines.",
"type": "string"
},
"city": {
"description": "The city of the address.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the address.",
"type": "string"
},
"country": {
"description": "The country of the address.",
"type": "string"
},
"county": {
"description": "The county 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": true
},
"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": true
},
"do_not_mail": {
"description": "Indicates whether the constituent requests not to be contacted at this address.",
"type": "boolean"
},
"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
},
"formatted_address": {
"description": "This computed field retrieves the formatted address in the configured format of the country.",
"type": "string"
},
"inactive": {
"description": "This computed field indicates that the address is active if the current date is before any <code>end</code> date.",
"type": "boolean"
},
"postal_code": {
"description": "The postal code of the address.",
"type": "string"
},
"preferred": {
"description": "Indicates whether this is the constituent's preferred address.",
"type": "boolean"
},
"seasonal_end": {
"description": "The time of the year ceases to reside at this address.",
"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"
},
"seasonal_start": {
"description": "The time of year that the constituent begins residing at this address.",
"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"
},
"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
},
"state": {
"description": "The state of the address.",
"type": "string"
},
"suburb": {
"description": "The suburb of the address.",
"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/ListAddressTypes\"><b>Address Types</b></a> table.",
"type": "string"
},
"region": {
"description": "The region of the address.",
"type": "string"
},
"information_source": {
"description": "The information source for the address.",
"type": "string"
},
"lot": {
"description": "The Line of Travel (LOT) for the address.",
"type": "string"
},
"cart": {
"description": "The Carrier Route (CART) for the address.",
"type": "string"
},
"dpc": {
"description": "The Delivery Point Code (DPC) for the address.",
"type": "string"
}
},
"x-display-name": "Address",
"x-display-id": "Address_01",
"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> — 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> — Use the <code>state</code> property to track provinces.</p>\r\n</div>"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 400 Bad Request
Returned when the specified constituent ID in the request URL is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to view the addresses.
Response 404 Not Found
Returned when the specified constituent is not found.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/addresses?include_inactive={boolean}"
-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["include_inactive"] = "{boolean}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/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/constituents/{constituent_id}/addresses");
builder.setParameter("include_inactive", "{boolean}");
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
"include_inactive": "{boolean}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/constituents/{constituent_id}/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/constituents/{constituent_id}/addresses";
NSArray* array = @[
// Request parameters
@"entities=true",
@"include_inactive={boolean}",
];
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/{constituent_id}/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
'include_inactive' => '{boolean}',
);
$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
'include_inactive': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/{constituent_id}/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
'include_inactive': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/{constituent_id}/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/constituents/{constituent_id}/addresses')
query = URI.encode_www_form({
# Request parameters
'include_inactive' => '{boolean}'
})
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