Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
GET
Membership list (All constituents)
Returns a paginated list of memberships.
The default sorting behavior is to list memberships in ascending order based on when they were created. However, thelast_modified parameter overrides the default sorting behavior to list memberships 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 memberships 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 memberships based on when they were last modified.
Try it
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| date_added | string | Represents a filter for memberships 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 memberships 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 memberships. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request. |
|
| 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 membership entities.
{
"count": 2,
"value": [
{
"id": "53",
"category": "Young Maestros",
"dues": {
"value": 750
},
"expires": "2002-03-17T00:00:00Z",
"joined": "2000-05-01T00:00:00Z",
"members": [
{
"id": "72",
"constituent_id": "261",
"primary": true
},
{
"id": "73",
"constituent_id": "526",
"primary": false
},
{
"id": "74",
"constituent_id": "483",
"primary": false
}
],
"program": "Young Explorers",
"standing": "Active",
"subcategory": "Elementary"
},
{
"id": "82",
"category": "Young Maestros",
"dues": {
"value": 750
},
"expires": "2009-04-14T00:00:00Z",
"joined": "2003-01-22T00:00:00Z",
"members": [
{
"id": "110",
"constituent_id": "483",
"primary": true
}
],
"program": "Young Explorers",
"standing": "Lapsed"
}
]
}{
"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": "Membership programs encourage donor loyalty and reward constituents for their support with exclusive, personalized benefits. Memberships also encourage occasional donors to become regular givers through annual renewals.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the membership.",
"type": "string"
},
"category": {
"description": "The membership category.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the membership.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "The date when the membership 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 membership 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
},
"dues": {
"description": "The membership dues.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"expires": {
"format": "date-time",
"description": "The date when the membership expires. 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
},
"joined": {
"format": "date-time",
"description": "The date when the membership becomes active. 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
},
"members": {
"description": "The set of members who belong to the membership.",
"type": "array",
"items": {
"description": "Members are constituents who join your organization through memberships that encourage more active involvement. Members are usually more involved with your organization than other donors, even if their only contribution is routine giving.",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the member.",
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the member.",
"type": "string"
},
"primary": {
"description": "Indicates whether this is the primary member on the membership.",
"type": "boolean"
}
},
"x-display-name": "Member",
"x-display-id": "Member"
}
},
"program": {
"description": "The membership program.",
"type": "string"
},
"standing": {
"description": "The membership status. Available values are <i>New</i>, <i>Active</i>, <i>Lapsed</i>, and <i>Dropped</i>.",
"enum": [
"New",
"Active",
"Lapsed",
"Dropped"
],
"type": "string"
},
"subcategory": {
"description": "The membership subcategory.",
"type": "string"
}
},
"x-display-name": "Membership",
"x-display-id": "Membership"
}
}
},
"x-hidden": true,
"x-base-type": "#/definitions/ApiCollection"
}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 memberships.
Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/memberships?date_added={string}&last_modified={string}&sort_token={string}&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["limit"] = "{integer}";
queryString["offset"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/constituent/v1/memberships?" + 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/memberships");
builder.setParameter("date_added", "{string}");
builder.setParameter("last_modified", "{string}");
builder.setParameter("sort_token", "{string}");
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}",
"limit": "{integer}",
"offset": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/constituent/v1/memberships?" + $.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/memberships";
NSArray* array = @[
// Request parameters
@"entities=true",
@"date_added={string}",
@"last_modified={string}",
@"sort_token={string}",
@"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/memberships');
$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}',
'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}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/memberships?%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}',
'limit': '{integer}',
'offset': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/constituent/v1/memberships?%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/memberships')
query = URI.encode_www_form({
# Request parameters
'date_added' => '{string}',
'last_modified' => '{string}',
'sort_token' => '{string}',
'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