Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
GET
Constituent (Duplicate search)
Returns possible duplicate records. Searches individual, organization, and related contact records and ranks results based on search filters. Records that match multiple filters rank higher as potential duplicates.
Try itRequest URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| last_org_name | Property is required | string | A required filter for records that match the specified last name or organization name. |
| search_individuals | boolean | A filter indicating whether to search for duplicate individual or organization records. This property defaults to true if no value is provided. |
|
| search_aliases | boolean | A filter indicating whether to search by the alias specified in the last_org_name parameter. This property defaults to false if no value is provided. |
|
| search_contacts | boolean | A filter indicating whether to search relationship contact records. This property defaults to false if no value is provided. |
|
| first_name | string | A filter for individual records that match the specified first name. |
|
| middle_name | string | A filter for individual records that match the specified middle name. |
|
| suffix | string | A filter for individual records that match the specified suffix. |
|
| address_block | string | A filter for records that match the specified address block. |
|
| city | string | A filter for records that match the specified city. |
|
| state | string | A filter for records that match the specified state. |
|
| post_code | string | A filter for records that match the specified postcode. |
|
| array | A filter for records that match the specified email addresses. |
||
| phone | array | A filter for records that match the specified phone numbers. |
|
| limit | integer | The number of records to return when paging results (Default = 3). |
|
| offset | integer | The number of records to skip when paging results. |
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
The response body contains a collection of duplicate search result entities.
{
"count": 3,
"value": [
{
"id": "280",
"constituent_id": "600",
"name": "Dr. Robert Carlos Hernandez",
"formatted_address": "27 Parkview Road\r\nManchester, NH 03109",
"deceased": false,
"is_constituent": true,
"date_added": "1999-05-20T14:57:55Z",
"rank": "0.85",
"display_name": "Robert C. Hernandez"
},
{
"id": "864",
"constituent_id": "600",
"name": "Mr. Robert C. Hernandez",
"formatted_address": "",
"deceased": false,
"is_constituent": true,
"date_added": "1999-05-20T14:57:55Z",
"rank": "0.95",
"display_name": "Robert C. Hernandez"
},
{
"id": "280",
"constituent_id": "600",
"name": "Mr. Rob C. Hernandez",
"formatted_address": "410 17th Street\r\nDenver, CO 80202-4402",
"deceased": false,
"is_constituent": true,
"date_added": "2010-05-20T14:57:55Z",
"rank": "0.70",
"display_name": "Rob 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": "Represents a constituent record that matches the provided duplicate search options.",
"type": "object",
"properties": {
"id": {
"description": "The primary identifier for the constituent.",
"type": "string"
},
"constituent_id": {
"description": "The import identifier for the constituent.",
"type": "string"
},
"name": {
"description": "The constituent's name formatted according to the user-defined configuration settings in database view. This is how the constituent's name appears at the top of a record.",
"type": "string"
},
"formatted_address": {
"description": "The formatted primary address for the constituent.",
"type": "string"
},
"deceased": {
"description": "Indicates whether the constituent is deceased.",
"type": "boolean"
},
"is_constituent": {
"description": "Indicates whether the record is for a constituent.",
"type": "boolean"
},
"date_added": {
"format": "date-time",
"description": "The date the constituent was added.",
"type": "string",
"x-supports-datetime-offset": false
},
"rank": {
"description": "The search rank indicating what the constituent was matched on.",
"type": "string"
},
"display_name": {
"description": "The constituent's display name (first name, middle initial, and last name for individuals) as it appears on lists and in search results.",
"type": "string"
}
},
"x-display-name": "Duplicate search result",
"x-display-id": "DuplicateSearchResult"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}Response 400 Bad Request
Returned when the specified request body is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to view the constituent.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name}?search_individuals={boolean}&search_aliases={boolean}&search_contacts={boolean}&first_name={string}&middle_name={string}&suffix={string}&address_block={string}&city={string}&state={string}&post_code={string}&email={array}&phone={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["search_individuals"] = "{boolean}";
queryString["search_aliases"] = "{boolean}";
queryString["search_contacts"] = "{boolean}";
queryString["first_name"] = "{string}";
queryString["middle_name"] = "{string}";
queryString["suffix"] = "{string}";
queryString["address_block"] = "{string}";
queryString["city"] = "{string}";
queryString["state"] = "{string}";
queryString["post_code"] = "{string}";
queryString["email"] = "{array}";
queryString["phone"] = "{array}";
queryString["limit"] = "{integer}";
queryString["offset"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name}&" + 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/duplicatesearch?last_org_name={last_org_name}");
builder.setParameter("search_individuals", "{boolean}");
builder.setParameter("search_aliases", "{boolean}");
builder.setParameter("search_contacts", "{boolean}");
builder.setParameter("first_name", "{string}");
builder.setParameter("middle_name", "{string}");
builder.setParameter("suffix", "{string}");
builder.setParameter("address_block", "{string}");
builder.setParameter("city", "{string}");
builder.setParameter("state", "{string}");
builder.setParameter("post_code", "{string}");
builder.setParameter("email", "{array}");
builder.setParameter("phone", "{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
"search_individuals": "{boolean}",
"search_aliases": "{boolean}",
"search_contacts": "{boolean}",
"first_name": "{string}",
"middle_name": "{string}",
"suffix": "{string}",
"address_block": "{string}",
"city": "{string}",
"state": "{string}",
"post_code": "{string}",
"email": "{array}",
"phone": "{array}",
"limit": "{integer}",
"offset": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name}&" + $.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/duplicatesearch?last_org_name={last_org_name}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"search_individuals={boolean}",
@"search_aliases={boolean}",
@"search_contacts={boolean}",
@"first_name={string}",
@"middle_name={string}",
@"suffix={string}",
@"address_block={string}",
@"city={string}",
@"state={string}",
@"post_code={string}",
@"email={array}",
@"phone={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/duplicatesearch?last_org_name={last_org_name}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'search_individuals' => '{boolean}',
'search_aliases' => '{boolean}',
'search_contacts' => '{boolean}',
'first_name' => '{string}',
'middle_name' => '{string}',
'suffix' => '{string}',
'address_block' => '{string}',
'city' => '{string}',
'state' => '{string}',
'post_code' => '{string}',
'email' => '{array}',
'phone' => '{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
'search_individuals': '{boolean}',
'search_aliases': '{boolean}',
'search_contacts': '{boolean}',
'first_name': '{string}',
'middle_name': '{string}',
'suffix': '{string}',
'address_block': '{string}',
'city': '{string}',
'state': '{string}',
'post_code': '{string}',
'email': '{array}',
'phone': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name}&%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
'search_individuals': '{boolean}',
'search_aliases': '{boolean}',
'search_contacts': '{boolean}',
'first_name': '{string}',
'middle_name': '{string}',
'suffix': '{string}',
'address_block': '{string}',
'city': '{string}',
'state': '{string}',
'post_code': '{string}',
'email': '{array}',
'phone': '{array}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name}&%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/duplicatesearch?last_org_name={last_org_name}')
query = URI.encode_www_form({
# Request parameters
'search_individuals' => '{boolean}',
'search_aliases' => '{boolean}',
'search_contacts' => '{boolean}',
'first_name' => '{string}',
'middle_name' => '{string}',
'suffix' => '{string}',
'address_block' => '{string}',
'city' => '{string}',
'state' => '{string}',
'post_code' => '{string}',
'email' => '{array}',
'phone' => '{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