Constituent

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

GET Constituent list

Returns a paginated list of constituents.

The default sorting behavior is to list constituents in ascending alphabetical order based on the full name of organizations and the last name of individuals. However, some parameters override the default sorting behavior. The sort parameter sorts based on the fields that it specifies, and the sort_token parameter sorts based on the next stable-sorted list of results. (These parameters cannot be provided together.) If the sort and sort_token parameters are not provided, then the last_modified parameter sorts constituents in ascending order based on when they were last modified and the date_added parameter sorts constituents in ascending order based on when they were created. (If the last_modified and date_added parameters are both specified, sorting is based on the last-modified date.)

Some parameters also add the sort_token parameter to the next_link URL to ensure that constituents are stably sorted and that the order persists even if changes occur while working through a paginated list. The last_modified, date_added, and sort parameters all add the sort_token parameter to the next_link URL, although the sort parameter only adds the sort_token parameter when it sorts by just the date_added field or just the date_modified field.

Note: This endpoint returns data with an average latency of about 30 minutes.

Try it

Request URL

Request parameters

include_inactive boolean

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

include_deceased boolean

Set this parameter to "true" to include deceased constituents in the response.

postal_code string

Represents a comma-separated list of postal codes. Returns constituents when their preferred addresses have postal codes that match a provided postal code. For example, "postal_code=99577[,Postal Code #2]" returns constituents whose preferred address has a postal code of 99577-0727.

fields string

Represents the fields to include on the returned records. For example, "fields=id,first,last,deceased_date". The "id" field will always be returned.

constituent_code array

Represents a list of constituent codes. Returns constituents if any of the specified constituent codes match any of their active constituent codes. For example, "constituent_code=Board Member&constituent_code=Volunteer" returns constituents with either "Board Member" or "Volunteer" constituent codes.

custom_field_category array

Represents a list of custom field categories. Returns constituents if any of the specified custom field categories match any of their active custom fields. For example, "custom_field_category=Interests&custom_field_category=Anniversary" returns constituents with either "Interests" or "Anniversary" custom fields.

date_added string

Represents a filter for results created on or after the specified date. Adds the sort_token parameter to the next_link URL to ensure that constituents are stably sorted. 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 results modified on or after the specified date. Adds the sort_token parameter to the next_link URL to ensure that constituents are stably sorted. 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 results and to ensure that the order persists even if changes occur while working through a paginated list. The token is provided on the next_link collection response property when the request specifies the sort_token filter. The last_modified, date_added, and sort parameters also add the token to the next_link URL, although the sort parameter only adds the token when it sorts by just the date_added field or just the date_modified field.

sort string

Represents a list of fields to sort the results by. Returns a list that sorts constituents based on the supplied fields. Results are in ascending order by default, and a '-' sign denotes descending order. For example, "sort=date_added,-last" sorts constituents by the "date_added" field in ascending order and then by the "last" field in descending order. If only the date_modified field or only the date_added field is provided, then this adds the sort_token parameter to the next_link URL to ensure that constituents are stably sorted.

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

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

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

{
  "count": 241,
  "next_link": "https://api.sky.blackbaud.com/constituent/v1/constituents?limit=3&last_modified=2016-05-05T17%3a59%3a31.1600745-04%3a00&sort_token=AAAAAAAC%2bI4%3d",
  "value": [
    {
      "id": "187",
      "type": "individual",
      "lookup_id": "3",
      "inactive": false,
      "name": "Mr. Mark D. Adamson, III",
      "last": "Adamson",
      "first": "Mark",
      "middle": "Daniel",
      "suffix": ", III",
      "title": "Mr.",
      "gender": "male",
      "birthdate": {
        "y": 1954,
        "m": 9,
        "d": 23
      },
      "age": 61,
      "deceased": false,
      "address": {
        "id": "279",
        "constituent_id": "187",
        "formatted_address": "125 Smokerise Way\r\nCharleston, SC  29401",
        "preferred": true,
        "address_lines": "125 Smokerise Way",
        "city": "Charleston",
        "state": "SC",
        "postal_code": "29401",
        "county": "Charleston",
        "country": "United States"
      },
      "email": {
        "id": "973",
        "constituent_id": "187",
        "type": "Email",
        "address": "madamson@sncn.net",
        "do_not_email": false,
        "primary": false,
        "inactive": false
      },
      "phone": {
        "id": "4",
        "constituent_id": "187",
        "type": "Home",
        "number": "843-798-6698",
        "do_not_call": false,
        "primary": false,
        "inactive": false
      },
      "date_added": "2008-05-19T14:45:09.04+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00",
      "gives_anonymously": true
    },
    {
      "id": "280",
      "type": "individual",
      "lookup_id": "96",
      "inactive": false,
      "name": "Dr. Robert C. Hernandez",
      "last": "Hernandez",
      "first": "Robert",
      "middle": "Carlos",
      "preferred_name": "Bob",
      "title": "Dr.",
      "gender": "male",
      "birthdate": {
        "y": 1961,
        "m": 3,
        "d": 14
      },
      "age": 54,
      "deceased": false,
      "address": {
        "id": "687",
        "constituent_id": "280",
        "formatted_address": "410 17th Street\r\nDenver, CO  80202-4402",
        "preferred": true,
        "address_lines": "410 17th Street",
        "city": "Denver",
        "state": "CO",
        "postal_code": "80202-4402",
        "county": "Denver",
        "country": "United States"
      },
      "email": {
        "id": "283",
        "constituent_id": "280",
        "type": "Email",
        "address": "robertcarloshernandez@gmail.com",
        "do_not_email": false,
        "primary": false,
        "inactive": false
      },
      "phone": {
        "id": "95",
        "constituent_id": "280",
        "type": "Home",
        "number": "303-997-3301",
        "do_not_call": false,
        "primary": false,
        "inactive": false
      },
      "online_presence": {
        "id": "811",
        "constituent_id": "280",
        "type": "Web address",
        "address": "http://www.myspace.com/drbobhernandez",
        "primary": false,
        "inactive": false
      },
      "spouse": {
        "id": "410",
        "last": "Hernandez",
        "first": "Wendy"
      },
      "date_added": "2000-04-26T15:26:45.977+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00"
    },
    {
      "id": "410",
      "type": "individual",
      "inactive": false,
      "last": "Hernandez",
      "first": "Wendy",
      "title": "Mrs.",
      "gender": "female",
      "birthdate": {
        "y": 1962,
        "m": 12,
        "d": 11
      },
      "age": 53,
      "deceased": false,
      "address": {
        "formatted_address": "410 17th Street\r\nDenver, CO  80202-4402",
        "preferred": true,
        "address_lines": "410 17th Street",
        "city": "Denver",
        "state": "CO",
        "postal_code": "80202-4402",
        "county": "Denver",
        "country": "United States"
      },
      "email": {
        "id": "1196",
        "type": "Email",
        "address": "wendycorizonhernandez@gmail.com",
        "do_not_email": false,
        "primary": false,
        "inactive": false
      },
      "phone": {
        "id": "1510",
        "type": "Home",
        "number": "303-997-3301",
        "do_not_call": false,
        "primary": false,
        "inactive": false
      },
      "spouse": {
        "id": "280",
        "last": "Hernandez",
        "first": "Robert"
      },
      "date_added": "2000-04-26T16:00:04.51+00:00",
      "date_modified": "2016-06-21T02:47:20.2371396+00:00"
    }
  ]
}
{
  "description": "Represents a collection of items",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of items in the collection.",
      "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": "Contains basic information about a constituent record",
        "type": "object",
        "properties": {
          "id": {
            "description": "The constituent identifier.",
            "type": "string"
          },
          "type": {
            "description": "The type of constituent. Available values are <i>individual</i> and <i>organization</i>.",
            "enum": [
              "individual",
              "organization"
            ],
            "type": "string"
          },
          "lookup_id": {
            "description": "The user-defined identifier for the constituent.",
            "type": "string"
          },
          "inactive": {
            "description": "Indicates whether the constituent is inactive.",
            "type": "boolean"
          },
          "name": {
            "description": "The constituent's full name.",
            "type": "string"
          },
          "last": {
            "description": "The constituent's last name.",
            "type": "string"
          },
          "first": {
            "description": "The constituent's first name.",
            "type": "string"
          },
          "middle": {
            "description": "The constituent's preferred name.",
            "type": "string"
          },
          "preferred_name": {
            "description": "The constituent's preferred name.",
            "type": "string"
          },
          "former_name": {
            "description": "The constituent's former name.",
            "type": "string"
          },
          "suffix": {
            "description": "The constituent's primary suffix. Available values are the entries in the <b>Suffix Types</b> table.",
            "type": "string"
          },
          "suffix_2": {
            "description": "The constituent's secondary suffix. Available values are the entries in the <b>Suffix Types</b> table.",
            "type": "string"
          },
          "title": {
            "description": "The constituent's primary title. Available values are the entries in the <b>Title Types</b> table.",
            "type": "string"
          },
          "title_2": {
            "description": "The constituent's secondary title. Available values are the entries in the <b>Title Types</b> table.",
            "type": "string"
          },
          "gender": {
            "description": "The constituent's gender. Available values are <i>male</i>, <i>female</i>, and <i>unknown</i>.",
            "type": "string"
          },
          "birthdate": {
            "description": "The constituent's birthdate.",
            "type": "object",
            "properties": {
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date"
          },
          "age": {
            "format": "int32",
            "description": "The constituent's age.",
            "type": "integer"
          },
          "deceased": {
            "description": "Indicates whether the constituent is deceased.",
            "type": "boolean"
          },
          "deceased_date": {
            "description": "The date when the constituent died.",
            "type": "object",
            "properties": {
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date"
          },
          "address": {
            "description": "The constituent's preferred address.",
            "type": "object",
            "properties": {
              "id": {
                "description": "The address identifier.",
                "type": "string"
              },
              "constituent_id": {
                "description": "The constituent identifier.",
                "type": "string"
              },
              "type": {
                "description": "The address type. Available values are the entries in the <b>Address Types</b> table.",
                "type": "string"
              },
              "formatted_address": {
                "description": "The formatted address.",
                "type": "string"
              },
              "preferred": {
                "description": "Indicates whether this is the constituent's preferred address.",
                "type": "boolean"
              },
              "inactive": {
                "description": "Indicates whether the address is inactive.",
                "type": "boolean"
              },
              "do_not_mail": {
                "description": "Indicates whether the constituent requests not to be contacted at this address.",
                "type": "boolean"
              },
              "address_lines": {
                "description": "The address lines.",
                "type": "string"
              },
              "city": {
                "description": "The city of the address.",
                "type": "string"
              },
              "suburb": {
                "description": "The suburb of the address.",
                "type": "string"
              },
              "county": {
                "description": "The county of the address.",
                "type": "string"
              },
              "state": {
                "description": "The state of the address.",
                "type": "string"
              },
              "postal_code": {
                "description": "The postal code of the address.",
                "type": "string"
              },
              "country": {
                "description": "The country of the address.",
                "type": "string"
              },
              "date_added": {
                "format": "date-time",
                "description": "The date when the address 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"
              },
              "date_modified": {
                "format": "date-time",
                "description": "The date when the address 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"
              }
            },
            "example": {
              "constituent_id": "280",
              "type": "Home",
              "preferred": true,
              "do_not_mail": false,
              "address_lines": "410 18th Street",
              "city": "Denver",
              "county": "Denver",
              "state": "CO",
              "postal_code": "80209-4402",
              "country": "United States"
            },
            "x-additional-info": "\r\n<p>Some <b>Address</b> entity properties include international address support.</p>\r\n\r\n<div class=\"table-responsive\">\r\n    <table class=\"table table-striped table-hover\">\r\n        <thead>\r\n            <tr>\r\n                <th><strong>Property</strong></th>\r\n                <th><strong>United States</strong></th>\r\n                <th><strong>Canada</strong></th>\r\n                <th><strong>United Kingdom</strong></th>\r\n                <th><strong>Australia</strong></th>\r\n                <th><strong>New Zealand</strong></th>\r\n            </tr>\r\n        </thead>\r\n        <tbody>\r\n            <tr>\r\n                <td>address_lines</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>city</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>*</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>suburb</td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>state</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>!</td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>postal_code</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>county</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>country</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>\r\n\r\n<div class=\"footnotes\">\r\n    <p class=\"footnote\">* <b>Australia</b> &mdash; For <code>GET</code> operations, the <code>city</code> property returns city or suburb data. For <code>POST</code> and <code>PATCH</code> operations, you can use either the <code>suburb</code> or <code>city</code> properties, but not both. An error occurs if you provide values for both properties.</p>\r\n    <p class=\"footnote\">! <b>Canada</b> &mdash; Use the <code>state</code> property to track provinces.</p>\r\n</div>"
          },
          "email": {
            "description": "The constituent's primary email address, or the constituent's first email address if no email address is marked as primary.",
            "type": "object",
            "properties": {
              "id": {
                "description": "The email address identifier.",
                "type": "string"
              },
              "constituent_id": {
                "description": "The constituent identifier.",
                "type": "string"
              },
              "type": {
                "description": "The type of email address. Available values are the entries in the <b>Email Address Types</b> table.",
                "type": "string"
              },
              "address": {
                "description": "The email address.",
                "type": "string"
              },
              "do_not_email": {
                "description": "Indicates whether the constituent requests not to be contacted at this email address.",
                "type": "boolean"
              },
              "primary": {
                "description": "Indicates whether this is the constituent's primary email address.",
                "type": "boolean"
              },
              "inactive": {
                "description": "Indicates whether the email address is inactive.",
                "type": "boolean"
              },
              "date_added": {
                "format": "date-time",
                "description": "The date when the email address 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"
              },
              "date_modified": {
                "format": "date-time",
                "description": "The date when the email address 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"
              }
            },
            "example": {
              "constituent_id": "280",
              "type": "Email",
              "address": "dryang@outlook.com",
              "do_not_email": false,
              "primary": false,
              "inactive": false
            },
            "x-display-name": "Email address"
          },
          "phone": {
            "description": "The constituent's primary phone, or the constituent's first phone if no phone is marked as primary.",
            "type": "object",
            "properties": {
              "id": {
                "description": "The phone identifier.",
                "type": "string"
              },
              "constituent_id": {
                "description": "The constituent identifier.",
                "type": "string"
              },
              "type": {
                "description": "The phone type. Available values are the entries in the <b>Phone Types</b> table.",
                "type": "string"
              },
              "number": {
                "description": "The phone number.",
                "type": "string"
              },
              "do_not_call": {
                "description": "Indicates whether the constituent requests not to be contacted at this number.",
                "type": "boolean"
              },
              "primary": {
                "description": "Indicates whether this is the constituent's primary phone.",
                "type": "boolean"
              },
              "inactive": {
                "description": "Indicates whether the phone is inactive.",
                "type": "boolean"
              },
              "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"
              },
              "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"
              }
            },
            "example": {
              "constituent_id": "280",
              "type": "Home",
              "number": "520-847-2445",
              "primary": false,
              "inactive": false,
              "do_not_call": false
            }
          },
          "online_presence": {
            "description": "The constituent's primary online presence, or the constituent's first online presence if no online presense is marked as primary.",
            "type": "object",
            "properties": {
              "id": {
                "description": "The online presence identifier.",
                "type": "string"
              },
              "constituent_id": {
                "description": "The constituent identifier.",
                "type": "string"
              },
              "type": {
                "description": "The online presence type. Available values are the entries in the <b>Online Presence Types</b> table.",
                "type": "string"
              },
              "address": {
                "description": "The web address for the online presence.",
                "type": "string"
              },
              "primary": {
                "description": "Indicates whether this is the constituent's primary online presence.",
                "type": "boolean"
              },
              "inactive": {
                "description": "Indicates whether the online presence is inactive.",
                "type": "boolean"
              },
              "date_added": {
                "format": "date-time",
                "description": "The date when the online presence 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"
              },
              "date_modified": {
                "format": "date-time",
                "description": "The date when the online presence 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"
              }
            },
            "example": {
              "constituent_id": "280",
              "type": "Web address",
              "address": "http://www.myspace.com/drbobhernandez",
              "primary": false,
              "inactive": false
            },
            "x-display-name": "Online presence"
          },
          "marital_status": {
            "description": "The constituent's marital status. Available values are the entries in the <b>Marital Statuses</b> table.",
            "type": "string"
          },
          "spouse": {
            "description": "The constituent's spouse.",
            "type": "object",
            "properties": {
              "id": {
                "description": "The spouse identifier.",
                "type": "string"
              },
              "last": {
                "description": "The spouse's last name.",
                "type": "string"
              },
              "first": {
                "description": "The spouse's first name.",
                "type": "string"
              }
            }
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the constituent 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"
          },
          "date_modified": {
            "format": "date-time",
            "description": "The date when the constituent 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"
          },
          "gives_anonymously": {
            "description": "Indicates whether the constituent gives anonymously.",
            "type": "boolean"
          }
        },
        "example": {
          "type": "individual",
          "last": "Trout",
          "first": "Kilgore",
          "middle": "X",
          "preferred_name": "Junior",
          "title": "Mr.",
          "suffix": ", Jr.",
          "gender": "male",
          "marital_status": "Single",
          "birthdate": {
            "y": 1963,
            "m": 3,
            "d": 14
          },
          "deceased": false,
          "email": {
            "type": "Email",
            "address": "Kilgore_Trout64@gmail.com",
            "do_not_email": false,
            "primary": true,
            "inactive": false
          },
          "phone": {
            "type": "Home",
            "number": "843-537-3397",
            "do_not_call": false,
            "primary": true,
            "inactive": false
          },
          "gives_anonymously": false
        }
      }
    }
  },
  "x-hidden": true,
  "x-base-type": "#/definitions/Collection"
}

Response 400

Returned when the specified request parameters are not in the appropriate format.

Response 403

Returned when the user does not have permission to view the constituents.

Code samples

@ECHO OFF

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

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

        $.ajax({
            url: "https://api.sky.blackbaud.com/constituent/v1/constituents?" + $.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";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"include_inactive={boolean}",
                         @"include_deceased={boolean}",
                         @"postal_code={string}",
                         @"fields={string}",
                         @"constituent_code={array}",
                         @"custom_field_category={array}",
                         @"date_added={string}",
                         @"last_modified={string}",
                         @"sort_token={string}",
                         @"sort={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/constituents');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'bb-api-subscription-key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'include_inactive' => '{boolean}',
    'include_deceased' => '{boolean}',
    'postal_code' => '{string}',
    'fields' => '{string}',
    'constituent_code' => '{array}',
    'custom_field_category' => '{array}',
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{string}',
    'sort' => '{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
    'include_inactive': '{boolean}',
    'include_deceased': '{boolean}',
    'postal_code': '{string}',
    'fields': '{string}',
    'constituent_code': '{array}',
    'custom_field_category': '{array}',
    'date_added': '{string}',
    'last_modified': '{string}',
    'sort_token': '{string}',
    'sort': '{string}',
    'limit': '{integer}',
    'offset': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/constituent/v1/constituents?%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
    'include_inactive': '{boolean}',
    'include_deceased': '{boolean}',
    'postal_code': '{string}',
    'fields': '{string}',
    'constituent_code': '{array}',
    'custom_field_category': '{array}',
    'date_added': '{string}',
    'last_modified': '{string}',
    'sort_token': '{string}',
    'sort': '{string}',
    'limit': '{integer}',
    'offset': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'include_inactive' => '{boolean}',
    'include_deceased' => '{boolean}',
    'postal_code' => '{string}',
    'fields' => '{string}',
    'constituent_code' => '{array}',
    'custom_field_category' => '{array}',
    'date_added' => '{string}',
    'last_modified' => '{string}',
    'sort_token' => '{string}',
    'sort' => '{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