Pull tables using the API, likely filtered by date range.

Derek Bowers
Derek Bowers
Second Anniversary Name Dropper Facilitator 1 June 2023 Monthly Challenge
in Blackbaud Raiser's Edge NXT® APIs

Hi at present we are provided with a Raisor's Edge backup file that we load into our SQL server and pull what we need from that. We would like to use the API to just pull the limited data that we need. Would it be possible to get some direction on where to start and how practical it is. I have experience with REST API's none with BlackBaud API yet.

Any help would be appreciated,

Thanks,

Derek

Comments

  • Bob Raymond
    Bob Raymond
    Second Anniversary Name Dropper Participant Facilitator 1

    @Derek Bowers The simplest way create a list with criteria you need in RE NXT and pull that list through the API. Here's the link for Gifts list.


  • Alex Wong
    Alex Wong Community All-Star
    Tenth Anniversary Kudos 5 Facilitator 4 bbcon 2025 Attendee Badge

    @Derek Bowers
    Depending on what information you planning to pull, it may or may not be available on SKY API.

    Having access to the database tables of RE allows you to pull anything and everything from RE database view data (note that backup from Blackbaud does not include data that is exclusively from webview of RE). developer.blackbaud.com is where you want to go check API reference and see what fields are available to pull in mass (some fields are not available via “list/mass" pull, but only available via “single” record call). for example, you can only get pledge installment and payment 1 pledge at a time, instead of being able to get all pledge's installment and payment

  • Alex Wong
    Alex Wong Community All-Star
    Tenth Anniversary Kudos 5 Facilitator 4 bbcon 2025 Attendee Badge

    @Derek Bowers
    Re-reading your title and question again…

    It appears you want to get gift information from API. Definitely doable and multiple ways to do so. It is easy but not easy at the same time depending on what you plan to do with the data.

    You can:

    • Pull “all” data into a data warehouse (SQL Server), almost like build your own “intervally” up-to-date database that you can run queries on or use in Power BI or other BI solutions
      • more work, more consideration, what should be pull every few hours in FULL or what should be pulled “iteratively”
      • not every data is available in SKY API
      • not every data is available via “list” pull in SKY API, some is pulled 1 record at a time
      • Benefits: run very complex reports to your liking (i.e. Pledge Report, Pledge Aging Report, Event participant report joining their giving history and across year over year's of the same event, etc, etc)
    • Pull “some” data for specific funcionality and purpose
      • pull list of gifts in certain date range + other criteria such as “large gift” (i.e. $1000+) and automate sending of large gift acknowledgement and “personal” thank you using your own company/org headers. Other things that can be included: reminder for upcoming pledge due; donor statement YTD with all gift's receipt YTD; event registered or upcoming registered reminding them to come; etc
      • automate eReceipting that is outside of RE NXT default eReceipt functionalities, such as letterheads in pdf, attachments, custom signature from directors, etc

    So you can do A LOT with SKY API, so would be good to start with, what is it that you want to achieve, and make more efficient and more human error.

  • Derek Bowers
    Derek Bowers
    Second Anniversary Name Dropper Facilitator 1 June 2023 Monthly Challenge

    @Bob Raymond Thanks very much, what would you recommend I use for a development environment? My end goal is to pull lists from the API and insert the data into SQL server tables. Visual Studio Code with an add on?

    Thanks again,

    Derek

Categories