Constituent

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

GET

Phone list (All constituents)

Returns a paginated list of phones.

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

However, the last_modified parameter overrides the default sorting behavior to list phones 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 phones 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 phones 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 phones 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 phones 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.

include_inactive boolean

Set this parameter to "true" to include inactive phones in the response.

sort_token string

Represents a token filter to provide the next stable-sorted list of phones. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request.

constituent_id array

Represents a list of constituent identifiers. Returns phones if any of the specified constituent identifiers match any of the phones' associated constituents. For example, "constituent_id=280&constituent_id=1232" returns phones with either "280" or "1232" constituent identifiers.

limit integer

Represents the number of records to return. The default is 500.

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 phone entities.

{
  "count": 574,
  "next_link": "https://api.sky.blackbaud.com/constituent/v1/phones?offset=4&limit=4",
  "value": [
    {
      "id": "1",
      "constituent_id": "281",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00",
      "do_not_call": true,
      "inactive": false,
      "number": "404-977-5810",
      "primary": false,
      "type": "Business"
    },
    {
      "id": "3",
      "constituent_id": "186",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00",
      "do_not_call": false,
      "inactive": false,
      "number": "912-555-1215",
      "primary": false,
      "type": "Home"
    },
    {
      "id": "4",
      "constituent_id": "187",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00",
      "do_not_call": false,
      "inactive": false,
      "number": "843-798-6698",
      "primary": false,
      "type": "Home"
    },
    {
      "id": "5",
      "constituent_id": "188",
      "date_added": "1600-01-01T00:00:00+00:00",
      "date_modified": "2016-10-19T19:42:38.775+00:00",
      "do_not_call": false,
      "inactive": false,
      "number": "612-321-0047",
      "primary": false,
      "type": "Home"
    }
  ]
}
{
  "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": "Phones store information about constituent phone numbers and where to call individuals and organizations.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the phone.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the phone.",
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the phone 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 phone 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_call": {
            "description": "Indicates whether the constituent requests not to be contacted at this number.",
            "type": "boolean"
          },
          "inactive": {
            "description": "Indicates whether the phone is inactive.",
            "type": "boolean"
          },
          "number": {
            "description": "The phone number.",
            "type": "string"
          },
          "primary": {
            "description": "Indicates whether this is the constituent's primary phone.",
            "type": "boolean"
          },
          "type": {
            "description": "The phone type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListPhoneTypes\"><b>Phone Types</b></a> table.",
            "type": "string"
          }
        },
        "x-display-name": "Phone",
        "x-display-id": "Phone"
      }
    }
  },
  "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 phones.

Code samples

@ECHO OFF

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

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

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

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/constituent/v1/phones?%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}',
    'include_inactive': '{boolean}',
    'sort_token': '{string}',
    'constituent_id': '{array}',
    'limit': '{integer}',
    'offset': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'include_inactive' => '{boolean}',
    'sort_token' => '{string}',
    'constituent_id' => '{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!