Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
GET
Constituent (Search)
Performs a constituent search based on the provided search text. Supports first name, last name, preferred name, former name, alias, email address, phone number, address, or lookup ID. Name combinations, such as first name and last name or preferred name and last name, are valid, but otherwise search only supports one parameter at a time.
By default, searches include results that sound similar to your criteria. For example, searches for "Smith" include matches for "Smyth" and other alternative spellings. Searching by phone number requires a minimum of 7 digits with no spaces or special characters. This search does not support wildcard characters — such as * or ? — used to search in the database view. If searching on a lookup id, thesearch_field property should be set to 'lookup_id'. This will allow the search results to be returned quicker.
If searching on an email address, the search_field property should be set to 'email_address'. This will allow the search results to be returned quicker.
Search results are limited to 500 records.
Try it
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| search_text | Property is required | string | The text to search for. If the search_text is a lookup_id, set the search_field to "lookup_id". If the search_text is an email address, set the search_field to "email_address". |
| 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, "fundraiser_status=Active,None" returns constituents whose fundraiser status that matches Active or None. Valid values for this filter are Active, Inactive, and None. |
|
| include_inactive | boolean | Set this parameter to "true" to include inactive constituents in the response. |
|
| search_field | string | Represents a field to search on. Currently, it supports lookup_id and email_address. Set search_field to lookup_id or email_address and then set search_text to the lookup_id or email_address to find. |
|
| strict_search | boolean | Set this parameter to "true" to exclude constituents whose names sound like the search text but are spelled differently. |
|
| 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. |
Response 200 OK
Returned when the operation succeeds. The response body contains a collection of search result entities.
{
"count": 3,
"next_link": "https://api.sky.blackbaud.com/constituent/v1/constituents/search?limit=3&offset=3&search_text=rob",
"value": [
{
"id": "495",
"address": "111 Berry Road\r\nGreenville, SC 29608",
"email": "dryang@outlook.com",
"fundraiser_status": "Active",
"lookup_id": "228",
"name": "Allison D. Goodson"
},
{
"id": "864",
"address": "",
"fundraiser_status": "Inactive",
"lookup_id": "336",
"name": "Rob Kalghn"
},
{
"id": "280",
"address": "410 17th Street\r\nDenver, CO 80202-4402",
"email": "robertcarloshernandez@gmail.com",
"fundraiser_status": "None",
"lookup_id": "96",
"name": "Robert C. Hernandez"
}
]
}{
"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": "The search result entity describes the search results from a basic constituent search based on provided search text.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the constituent.",
"type": "string"
},
"address": {
"description": "The constituent's preferred address.",
"type": "string"
},
"deceased": {
"description": "Indicates whether the constituent is deceased.",
"type": "boolean"
},
"email": {
"description": "The constituent's email address.",
"type": "string"
},
"fundraiser_status": {
"description": "The constituent's fundraiser status. If the constituent's <code>type</code> is <i>Individual</i>, this computed field indicates the whether the constituent is <i>Active</i>, <i>Inactive</i>, or <i>None</i>. If the constituent's <code>type</code> is <i>Organization</i>, this value will always be <i>None</i>.",
"type": "string"
},
"inactive": {
"description": "Indicates whether the constituent is inactive.",
"type": "boolean"
},
"lookup_id": {
"description": "The user-defined identifier for the constituent.",
"type": "string"
},
"name": {
"description": "The constituent name. If the constituent's <code>type</code> is <i>Individual</i>, this computed field indicates the full name of the constituent based on the target organization’s display name settings.",
"type": "string"
}
},
"x-display-name": "Search result",
"x-display-id": "SearchResult"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents/search?search_text={search_text}?fundraiser_status={array}&include_inactive={boolean}&search_field={string}&strict_search={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["fundraiser_status"] = "{array}";
queryString["include_inactive"] = "{boolean}";
queryString["search_field"] = "{string}";
queryString["strict_search"] = "{boolean}";
queryString["limit"] = "{integer}";
queryString["offset"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents/search?search_text={search_text}&" + 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/search?search_text={search_text}");
builder.setParameter("fundraiser_status", "{array}");
builder.setParameter("include_inactive", "{boolean}");
builder.setParameter("search_field", "{string}");
builder.setParameter("strict_search", "{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
"fundraiser_status": "{array}",
"include_inactive": "{boolean}",
"search_field": "{string}",
"strict_search": "{boolean}",
"limit": "{integer}",
"offset": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/constituents/search?search_text={search_text}&" + $.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/search?search_text={search_text}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"fundraiser_status={array}",
@"include_inactive={boolean}",
@"search_field={string}",
@"strict_search={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/constituents/search?search_text={search_text}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'fundraiser_status' => '{array}',
'include_inactive' => '{boolean}',
'search_field' => '{string}',
'strict_search' => '{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
'fundraiser_status': '{array}',
'include_inactive': '{boolean}',
'search_field': '{string}',
'strict_search': '{boolean}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/search?search_text={search_text}&%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
'fundraiser_status': '{array}',
'include_inactive': '{boolean}',
'search_field': '{string}',
'strict_search': '{boolean}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/search?search_text={search_text}&%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/search?search_text={search_text}')
query = URI.encode_www_form({
# Request parameters
'fundraiser_status' => '{array}',
'include_inactive' => '{boolean}',
'search_field' => '{string}',
'strict_search' => '{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
Comments