School

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

GET

User Custom Fields by role(s) (BETA)

Returns a paginated collection of users with Custom Admin Fields, limited to 100 users per page.
Includes both user custom fields and administration view only custom fields. Use the last UserId number as the marker value to return the next set of results. For example: marker=101 will return the second set of results.
Requires at least one of the following roles in the Education Management system:

  • Platform Manager

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
base_role_ids Property is required string

Comma delimited list of base role IDs to get users for.

marker integer

The user's ID to start at to return the next batch of data. Results will start with the next user in the result set.

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": 2,
  "value": [
    {
      "id": 1,
      "first_name": "John",
      "last_name": "Smith",
      "preferred_name": "Jonny",
      "custom_fields": [
        {
          "data_type_id": 2,
          "data_type": "int",
          "data_type_description": "Check Box List",
          "field_name": "Enrollment Type",
          "int_value": 1,
          "last_modified_user_id": 12345,
          "last_modified_date": "2018-08-30T12:00:00Z",
          "status": true,
          "unique": true,
          "required": true,
          "table_id": 1,
          "table_value_id": 1,
          "table_value": "one",
          "table_value_abbreviation": "one"
        },
        {
          "data_type_id": 9,
          "data_type": "bit",
          "data_type_description": "Yes/No",
          "field_name": "After Care",
          "bit_value": true,
          "last_modified_user_id": 12345,
          "last_modified_date": "2018-08-30T12:00:00Z",
          "status": true,
          "unique": false,
          "required": false
        },
        {
          "data_type_id": 7,
          "data_type": "nvarchar",
          "data_type_description": "Text Input",
          "field_name": "Authorized Pickup",
          "text_value": "GrandMother",
          "last_modified_user_id": 12345,
          "last_modified_date": "2018-08-30T12:00:00Z",
          "status": false,
          "unique": false,
          "required": false
        }
      ]
    },
    {
      "id": 2,
      "first_name": "Sally",
      "last_name": "Johnson",
      "preferred_name": "Sal",
      "custom_fields": [
        {
          "data_type_id": 7,
          "data_type": "nvarchar",
          "data_type_description": "Text Input",
          "field_name": "Authorized Pickup",
          "text_value": "Father",
          "last_modified_user_id": 12345,
          "last_modified_date": "2018-08-30T12:00:00Z",
          "status": false,
          "unique": false,
          "required": false
        }
      ]
    }
  ]
}
{
  "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": {
          "id": {
            "type": "integer",
            "description": "User Id",
            "format": "int32",
            "nullable": true
          },
          "first_name": {
            "type": "string",
            "description": "The first name of a user",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "description": "The last name of a user",
            "nullable": true
          },
          "preferred_name": {
            "type": "string",
            "description": "Preferred Name",
            "nullable": true
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id",
                  "nullable": true
                },
                "data_type_id": {
                  "type": "integer",
                  "description": "Data Type Id",
                  "format": "int32"
                },
                "data_type": {
                  "type": "string",
                  "description": "Data Type",
                  "nullable": true
                },
                "data_type_description": {
                  "type": "string",
                  "description": "Data Type Description",
                  "nullable": true
                },
                "field_name": {
                  "type": "string",
                  "description": "Field Name",
                  "nullable": true
                },
                "bit_value": {
                  "type": "boolean",
                  "description": "Bit Value",
                  "nullable": true
                },
                "int_value": {
                  "type": "integer",
                  "description": "Int Value",
                  "format": "int32",
                  "nullable": true
                },
                "decimal_value": {
                  "type": "number",
                  "description": "Decimal Value",
                  "format": "float",
                  "nullable": true
                },
                "text_value": {
                  "type": "string",
                  "description": "Text Value",
                  "nullable": true
                },
                "last_modified_user_id": {
                  "type": "integer",
                  "description": "Last Modified User Id",
                  "format": "int32"
                },
                "last_modified_date": {
                  "type": "string",
                  "description": "Last Modified Date",
                  "format": "date-time"
                },
                "status": {
                  "type": "boolean",
                  "description": "Status"
                },
                "unique": {
                  "type": "boolean",
                  "description": "Unique"
                },
                "required": {
                  "type": "boolean",
                  "description": "Required"
                },
                "table_id": {
                  "type": "integer",
                  "description": "Table Id",
                  "format": "int32",
                  "nullable": true
                },
                "table_value_id": {
                  "type": "integer",
                  "description": "Table Value Id",
                  "format": "int32",
                  "nullable": true
                },
                "table_value": {
                  "type": "string",
                  "description": "Table Value",
                  "nullable": true
                },
                "table_value_abbreviation": {
                  "type": "string",
                  "description": "Table Value Abbreviation",
                  "nullable": true
                }
              },
              "additionalProperties": false,
              "description": "Custom Field"
            },
            "description": "Custom Fields",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "UserAdminCustomField"
      },
      "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/users/customfields?base_role_ids={base_role_ids}?marker={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["marker"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/school/v1/users/customfields?base_role_ids={base_role_ids}&" + 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/users/customfields?base_role_ids={base_role_ids}");

            builder.setParameter("marker", "{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
            "marker": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/users/customfields?base_role_ids={base_role_ids}&" + $.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/users/customfields?base_role_ids={base_role_ids}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"marker={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/school/v1/users/customfields?base_role_ids={base_role_ids}');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'marker' => '{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
    'marker': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/school/v1/users/customfields?base_role_ids={base_role_ids}&%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
    'marker': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'marker' => '{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 Developer team? Please visit us on the SKY Developer Community!