Constituent

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

GET

Constituent custom field list (All constituents)

Returns a paginated list of constituent custom fields.

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

However, the last_modified parameter overrides the default sorting behavior to list constituent custom fields 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 constituent custom fields 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 constituent custom fields based on when they were last modified.

Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.

Try it

Request URL

Request parameters

Parameter Required Type Description
date_added string

Represents a filter for constituent custom fields 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 constituent custom fields 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 constituent custom fields. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request.

category array

Represents a filter for custom field categories. Returns any custom fields that match the specified category. For example, category=Interests returns custom fields with the Interests category.

value array

Represents a filter for custom field values. Must be used in conjunction with the category filter. Returns any custom fields in the specified category that match any of the specified values. For example, category=Interests&value=Baseball&value=Tennis returns Interests custom fields with the Baseball or Tennis values. Filtering by fuzzy date values must be in one of the following formats: YYYYMMDD, YYYY, YYYYMM, or MMDD. Any four digit value that starts with 13 or higher will be considered a year. Any four digit value that starts with 01-12 will be considered to be in MMDD format.

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, Implicit.

Response 200 OK

Returned when the operation succeeds. The response body contains a collection of custom field entities.

{
  "count": 229,
  "next_link": "https://api.sky.blackbaud.com/constituent/v1/constituents/customfields?offset=3&limit=3",
  "value": [
    {
      "id": "1",
      "category": "Business Hours",
      "comment": "Weekdays only",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "1600-01-01T00:00:00+00:00",
      "parent_id": "281",
      "type": "Text"
    },
    {
      "id": "2",
      "category": "Organization Type",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "1600-01-01T00:00:00+00:00",
      "parent_id": "281",
      "type": "CodeTableEntry"
    },
    {
      "id": "3",
      "category": "Business Hours",
      "comment": "Customer Service Center",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "1600-01-01T00:00:00+00:00",
      "parent_id": "300",
      "type": "Text"
    }
  ]
}

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 custom fields.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/constituent/v1/constituents/customfields?date_added={string}&last_modified={string}&sort_token={string}&category={array}&value={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["date_added"] = "{string}";
            queryString["last_modified"] = "{string}";
            queryString["sort_token"] = "{string}";
            queryString["category"] = "{array}";
            queryString["value"] = "{array}";
            queryString["limit"] = "{integer}";
            queryString["offset"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/constituent/v1/constituents/customfields?" + 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/customfields");

            builder.setParameter("date_added", "{string}");
            builder.setParameter("last_modified", "{string}");
            builder.setParameter("sort_token", "{string}");
            builder.setParameter("category", "{array}");
            builder.setParameter("value", "{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
            "date_added": "{string}",
            "last_modified": "{string}",
            "sort_token": "{string}",
            "category": "{array}",
            "value": "{array}",
            "limit": "{integer}",
            "offset": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/constituent/v1/constituents/customfields?" + $.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/customfields";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"date_added={string}",
                         @"last_modified={string}",
                         @"sort_token={string}",
                         @"category={array}",
                         @"value={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/customfields');
$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}',
    'category' => '{array}',
    'value' => '{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
    'date_added': '{string}',
    'last_modified': '{string}',
    'sort_token': '{string}',
    'category': '{array}',
    'value': '{array}',
    'limit': '{integer}',
    'offset': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/constituent/v1/constituents/customfields?%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}',
    'category': '{array}',
    'value': '{array}',
    'limit': '{integer}',
    'offset': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/constituent/v1/constituents/customfields?%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/customfields')

query = URI.encode_www_form({
    # Request parameters
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{string}',
    'category' => '{array}',
    'value' => '{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

Have a question? See a problem with our docs? Want to engage with the SKY API team? Please visit us on the SKY API Community!