School

This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.

GET

Directories results (BETA)

Returns a collection of directory results the logged in user has access to
search is an optional search string to filter directory results.
search_all allows the search string to be used for all fields.
When set to false, only searches name fields. defaults to true.
Requires at least one of the following roles in the Education Management System:

  • Parent
  • Faculty
  • Student

This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.

Try it

Request URL

Request parameters

Parameter Required Type Description
directory_id Property is required integer

Format - int32.
search string
search_all boolean

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

Success

{
  "count": 1,
  "value": [
    {
      "user_id": 12345,
      "first_name": "Tony",
      "last_name": "Stark",
      "email": "example@example.com",
      "address_line1": "1 Blackbaud Way",
      "address_line2": "",
      "address_line3": "",
      "city": "Bedford",
      "state": "NH",
      "zip": "03303",
      "country": "USA",
      "home_phone": "555-555-5555",
      "cell_phone": "556-555-5555",
      "home_phone2": "",
      "has_relationships": true,
      "prefix": "",
      "preferred_name": "Iron Man",
      "middlename": "",
      "maiden_name": "",
      "suffix": "",
      "grad_year": "2022",
      "grade": "10",
      "grade_display": "Tenth",
      "department": "",
      "department_display": "",
      "spouse_id": 0,
      "child_names": "",
      "grade_numeric": 10,
      "grade_numeric_display": "10",
      "total_count": 1,
      "deceased": false,
      "student": true,
      "preferred_address_id": 0,
      "preferred_address_lat": 0.0,
      "preferred_address_lng": 0.0,
      "job_title": ""
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of items in the collection",
      "format": "int32",
      "readOnly": true
    },
    "next_link": {
      "type": "string",
      "description": "For paginated responses, the URI for the next page of results",
      "nullable": true
    },
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "integer",
            "description": "The Id of the user",
            "format": "int32",
            "nullable": true
          },
          "first_name": {
            "type": "string",
            "description": "The first name of the user",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "description": "The last name of the user",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "The email address of the user",
            "nullable": true
          },
          "address_line1": {
            "type": "string",
            "description": "The first line of the user address",
            "nullable": true
          },
          "address_line2": {
            "type": "string",
            "description": "The second line of the user address",
            "nullable": true
          },
          "address_line3": {
            "type": "string",
            "description": "The third line of the user address",
            "nullable": true
          },
          "city": {
            "type": "string",
            "description": "The city the user lives in",
            "nullable": true
          },
          "state": {
            "type": "string",
            "description": "The state the user lives in",
            "nullable": true
          },
          "zip": {
            "type": "string",
            "description": "The zip code the user lives in",
            "nullable": true
          },
          "country": {
            "type": "string",
            "description": "The country the user lives in",
            "nullable": true
          },
          "home_phone": {
            "type": "string",
            "description": "The user's home phone number",
            "nullable": true
          },
          "cell_phone": {
            "type": "string",
            "description": "The user's cell phone number",
            "nullable": true
          },
          "office_phone": {
            "type": "string",
            "description": "The user's office phone number",
            "nullable": true
          },
          "home_phone2": {
            "type": "string",
            "description": "The user's secondary home phone number",
            "nullable": true
          },
          "has_relationships": {
            "type": "boolean",
            "description": "Returns true if the user has relationships",
            "nullable": true
          },
          "prefix": {
            "type": "string",
            "description": "The user's prefix",
            "nullable": true
          },
          "preferred_name": {
            "type": "string",
            "description": "The user's preferred name",
            "nullable": true
          },
          "middlename": {
            "type": "string",
            "description": "The user's middle name",
            "nullable": true
          },
          "maiden_name": {
            "type": "string",
            "description": "The user's maiden name",
            "nullable": true
          },
          "suffix": {
            "type": "string",
            "description": "The user's suffix",
            "nullable": true
          },
          "grad_year": {
            "type": "string",
            "description": "The user's graduation year",
            "nullable": true
          },
          "grade": {
            "type": "string",
            "description": "The user's grade",
            "nullable": true
          },
          "grade_display": {
            "type": "string",
            "description": "Grade display",
            "nullable": true
          },
          "department": {
            "type": "string",
            "description": "The department the user belongs to",
            "nullable": true
          },
          "department_display": {
            "type": "string",
            "description": "How the user's department should be displayed",
            "nullable": true
          },
          "spouse_id": {
            "type": "integer",
            "description": "The Id of the user's spouse",
            "format": "int32",
            "nullable": true
          },
          "child_names": {
            "type": "string",
            "description": "The user's children",
            "nullable": true
          },
          "grade_numeric": {
            "type": "integer",
            "description": "The numeric grade of the user",
            "format": "int32",
            "nullable": true
          },
          "grade_numeric_display": {
            "type": "string",
            "description": "The way the numeric grade should be displayed",
            "nullable": true
          },
          "total_count": {
            "type": "integer",
            "description": "The total count of records",
            "format": "int32",
            "nullable": true
          },
          "deceased": {
            "type": "boolean",
            "description": "Returns true if the user is deceased",
            "nullable": true
          },
          "student": {
            "type": "boolean",
            "description": "Returns true if the user is a student",
            "nullable": true
          },
          "preferred_address_id": {
            "type": "integer",
            "description": "The Id of the preferred address for the user",
            "format": "int32",
            "nullable": true
          },
          "preferred_address_lat": {
            "type": "number",
            "description": "Preferred address latitude",
            "format": "double",
            "nullable": true
          },
          "preferred_address_lng": {
            "type": "number",
            "description": "Preferred address longitude",
            "format": "double",
            "nullable": true
          },
          "job_title": {
            "type": "string",
            "description": "The user's job title",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Directory Result Model"
      },
      "description": "The set of items included in the response. This may be a subset of the items in the collection",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A Collection"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/school/v1/directories/{directory_id}?search={string}&search_all=true"
-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"] = "{string}";
            queryString["search_all"] = "true";
            var uri = "https://api.sky.blackbaud.com/school/v1/directories/{directory_id}?" + 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/school/v1/directories/{directory_id}");

            builder.setParameter("search", "{string}");
            builder.setParameter("search_all", "true");

            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": "{string}",
            "search_all": "true",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/directories/{directory_id}?" + $.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/school/v1/directories/{directory_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"search={string}",
                         @"search_all=true",
                      ];

    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/school/v1/directories/{directory_id}');
$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' => '{string}',
    'search_all' => 'true',
);

$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': '{string}',
    'search_all': 'true',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/directories/{directory_id}?%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': '{string}',
    'search_all': 'true',
})

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

query = URI.encode_www_form({
    # Request parameters
    'search' => '{string}',
    'search_all' => 'true'
})
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 Developer team? Please visit us on the SKY Developer Community!