Opportunity

This API manages opportunity information and related entities such as opportunity fundraisers, opportunity attachments, and opportunity custom fields.

GET

Opportunity list

Returns a paginated list of opportunities.

The default sorting behavior is to list opportunities in ascending order based on the id.

However, the last_modified parameter overrides the default sorting behavior to list opportunities in ascending order based on when they were last modified, and the date_added parameter overrides the default sorting behavior to list opportunities in ascending order based on when they were created. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that opportunities 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 opportunities based on when they were last modified.

Try it

Request URL

Request parameters

Parameter Required Type Description
date_added string

Represents a filter for opportunities 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 opportunities 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 opportunities in the response.

sort_token string

Represents a token filter to provide the next stable-sorted list of opportunities. 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 opportunities if any of the specified constituent identifiers match any of their constituents. For example, "constituent_id=280&constituent_id=1232" returns opportunities 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 opportunity entities.

{
  "count": 39,
  "next_link": "https://api.sky.blackbaud.com/opportunity/v1/opportunities?offset=3&limit=3",
  "value": [
    {
      "id": "2",
      "ask_amount": {
        "value": 10000
      },
      "ask_date": "2002-07-30T00:00:00",
      "campaign_id": "6",
      "constituent_id": "306",
      "date_added": "2000-01-19T14:11:02.453+00:00",
      "date_modified": "2002-07-30T14:28:39.173+00:00",
      "deadline": "2005-05-15T00:00:00",
      "expected_amount": {
        "value": 10000
      },
      "expected_date": "2004-05-15T00:00:00",
      "funded_amount": {
        "value": 10000
      },
      "funded_date": "2004-05-15T00:00:00",
      "fundraisers": [
        {
          "constituent_id": "194",
          "credit_amount": {
            "value": 10000
          }
        }
      ],
      "fund_id": "12",
      "inactive": false,
      "linked_gifts": [
        "208"
      ],
      "name": "Scholarship Proposal",
      "purpose": "Research Endowment",
      "status": "Strategy"
    },
    {
      "id": "3",
      "ask_amount": {
        "value": 200000
      },
      "ask_date": "2003-11-24T00:00:00",
      "campaign_id": "6",
      "constituent_id": "219",
      "date_added": "2000-03-14T14:10:47.227+00:00",
      "date_modified": "2004-10-11T14:52:54.277+00:00",
      "deadline": "2006-07-30T00:00:00",
      "expected_amount": {
        "value": 200000
      },
      "expected_date": "2005-06-01T00:00:00",
      "funded_amount": {
        "value": 500500
      },
      "funded_date": "2005-06-01T00:00:00",
      "fundraisers": [
        {
          "constituent_id": "188",
          "credit_amount": {
            "value": 254050
          }
        }
      ],
      "fund_id": "12",
      "inactive": false,
      "linked_gifts": [
        "101",
        "280",
        "489"
      ],
      "name": "Scholarship Proposal",
      "purpose": "Education - Endowment",
      "status": "Stewardship"
    },
    {
      "id": "4",
      "ask_amount": {
        "value": 100000
      },
      "ask_date": "2002-11-20T00:00:00",
      "campaign_id": "7",
      "constituent_id": "255",
      "date_added": "2000-03-15T15:19:57.91+00:00",
      "date_modified": "2004-10-12T19:45:03.093+00:00",
      "deadline": "2003-12-31T00:00:00",
      "expected_amount": {
        "value": 100000
      },
      "expected_date": "2003-12-31T00:00:00",
      "funded_amount": {
        "value": 150000
      },
      "funded_date": "2003-01-22T00:00:00",
      "fundraisers": [
        {
          "constituent_id": "230",
          "credit_amount": {
            "value": 150000
          }
        }
      ],
      "fund_id": "5",
      "name": "Planned Giving - Playground",
      "inactive": false,
      "purpose": "Major Gift",
      "status": "Stewardship"
    }
  ]
}
{
  "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": "Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the opportunity.",
            "type": "string"
          },
          "ask_amount": {
            "description": "The monetary amount solicited from the prospect for the opportunity.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "ask_date": {
            "format": "date-time",
            "description": "The date when the solicitation was made. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "campaign_id": {
            "description": "The immutable system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the opportunity.",
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the opportunity 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 opportunity 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
          },
          "deadline": {
            "format": "date-time",
            "description": "The goal date for the opportunity to result in a gift. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "expected_amount": {
            "description": "The monetary amount that is realistically expected to result from the opportunity.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "expected_date": {
            "format": "date-time",
            "description": "The date when the prospect is expected to give in response to the opportunity. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "fund_id": {
            "description": "The immutable system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift.",
            "type": "string"
          },
          "funded_amount": {
            "description": "The monetary amount that the prospect gave in response to the opportunity.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "funded_date": {
            "format": "date-time",
            "description": "The date when the prospect gave in response to the opportunity. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "fundraisers": {
            "description": "The set of immutable constituent system record IDs for the fundraisers assigned to the opportunity.",
            "type": "array",
            "items": {
              "description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and advance opportunities to secure major gifts. When the target constituent fulfills an opportunity ask, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
              "type": "object",
              "properties": {
                "constituent_id": {
                  "description": "The immutable system record ID of the constituent associated with the fundraiser.",
                  "type": "string"
                },
                "credit_amount": {
                  "description": "The amount credited to the fundraiser for the opportunity.",
                  "type": "object",
                  "properties": {
                    "value": {
                      "format": "double",
                      "description": "The monetary value.",
                      "type": "number"
                    }
                  }
                }
              },
              "x-display-name": "Opportunity fundraiser",
              "x-display-id": "OpportunityFundraiser"
            }
          },
          "inactive": {
            "description": "Indicates whether the opportunity is inactive.",
            "type": "boolean"
          },
          "linked_gifts": {
            "description": "The  immutable system record IDs of the gifts related to the opportunity.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "name": {
            "description": "The name that identifies the opportunity throughout the program, such as in lists or on constituent records.",
            "type": "string"
          },
          "purpose": {
            "description": "The intended use for any money raised as a result of the opportunity. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunityPurposes\"><b>Purposes</b></a> table.",
            "type": "string"
          },
          "status": {
            "description": "The status that indicates where the opportunity is in the solicitation process. This property can experience a data latency of about 10 minutes on the <a href=\"https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/58e3b27ba9db950fa048c8a9\">Opportunity (Get) endpoint</a>. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunityStatuses\"><b>Proposal Status</b></a> table.",
            "type": "string"
          }
        },
        "x-display-name": "Opportunity",
        "x-display-id": "Opportunity"
      }
    }
  },
  "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 opportunities.

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/opportunity/v1/opportunities?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/opportunity/v1/opportunities?" + 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/opportunity/v1/opportunities");

            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/opportunity/v1/opportunities?" + $.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/opportunity/v1/opportunities";
    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/opportunity/v1/opportunities');
$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", "/opportunity/v1/opportunities?%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", "/opportunity/v1/opportunities?%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/opportunity/v1/opportunities')

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!