New Blackbaud CRM APIs: Ad-hoc Query and Complete Blackbaud CRM Coverage

Chris Ager

We are excited to announce two new sets of Blackbaud CRM APIs, now available on the SKY API developer portal. Together they let you query your data on demand and work with core Blackbaud CRM functionality programmatically, so you can build integrations, automations and reporting solutions without working around gaps in the API.

Ad-hoc Query API

Ad-hoc queries are one of the most powerful ways to find and analyze constituent data in Blackbaud CRM. The new Ad-hoc Query API brings that capability to your own applications. You can save a query, run it, and retrieve results using standard REST calls.

The API includes six operations:

• Save an ad-hoc query – create and store a query definition so it can be reused.
• Execute an ad-hoc query – run a saved query and get the results.
• List ad-hoc query entries – discover the queries available to your application.
• Get an ad-hoc query definition – inspect how a query is built.
• Get a deferred ad-hoc query execution result – collect results from longer-running queries once they finish.
• Cancel a deferred ad-hoc query execution – stop a running query you no longer need.

Support for deferred execution means large queries do not have to hold a connection open. Start the query, check back for the result, and cancel it if circumstances change.

Where it helps

• Feeding Blackbaud CRM data into dashboards, data warehouses or external reporting tools.
• Building lightweight apps that let staff run approved queries without opening Blackbaud CRM.
• Automating recurring extracts for mailings, appeals or finance processes.

Completing API coverage for Blackbaud CRM functionality

The second group of endpoints completes a series of APIs that provide full coverage of Blackbaud CRM functionality. These operations mirror how Blackbaud CRM itself works, through data forms, data lists, business processes and record operations, so whatever users can do in the application can now be done through the API.

• Get a data form record, Create a data form record and Update a data form record – read, add and change records using the same data forms that power the Blackbaud CRM interface.
• Get data form defaults – retrieve default values before creating a record, just as the form does when a user opens it.
• Load a data list and Simple list load – retrieve list data, from full data lists to simpler list loads.
• Launch a business process – start Blackbaud CRM business processes from external systems.
• Perform record operation – run record-level operations on your data.

Where it helps

• Syncing constituent, gift or event data between Blackbaud CRM and other systems.
• Triggering business processes from outside Blackbaud CRM, such as when a form is submitted on your website.
• Building custom front ends on top of the same forms and lists your team already knows.

Getting started

Visit the SKY API developer portal to explore the full reference for each operation. If you are new to SKY API, the getting started guide walks you through creating a developer account, registering an application and authorizing requests.

We would love to hear what you build. Share your experiences, questions and ideas in the comments below or in the SKY Developer community.