GET Gift List does not contain gift_code

Dmitry Khomyakov

It seems like the output of Gift List API does not contain the gift_code field. The GET Gift API (each individual gift called by ID) has it. Can the Gift List API also have access to gift codes?

Anthony Gallo

Hi Dmitry,

We do have this occurrence with quite a few endpoints at the moment. We are doing a major list platform project that will help us out here once we are done but we are a while from completing that (approx. 12 months to be fully done). The gift list part may be more closer to the middle of that timeframe that the end and once we are done there we can look to add these gaps.

Gaylord Smith

@Anthony Gallo Any update/status on the overall platform project or, more specifically, the gift_code being part of GET Gift List? Thanks

Anthony Gallo

@Gaylord Smith We are still working on the gift list but we are also in the home stretch. The Action list is in EAP now and we should begin rollout there in early June. Once we are fully rolled out on the action list we will begin the EAP for gift list and then we will roll that out. The opportunity and Constituent lists are up next.

Gaylord Smith

@Anthony Gallo any update - was this released early June as anticipated? Thanks!

Anthony Gallo

@Gaylord Smith
The June comment had to do with the Action list and it is still in EAP. We are testing record level security and that list should start actual wave rollouts towards the end of the month. Gift list will start EAP once the Action list is fully rolled out, so sometime in August (as of right now).

Gaylord Smith

@Anthony Gallo always impressed with your quick responses - thank you! Also looking forward to the ‘Action List’ improvements as well!

Dennis Ladnier

@Anthony Gallo - I have been following this string - did the Action list updates start rolling the end of July. Thanks, Dennis

Anthony Gallo

@dennis ladnier we had some performance things that popped up that we wanted to handle before release and that is now compete. We are also currently waiting on a Microsoft issue to be resolved. Once that is good we will start our waves.

Stephen Taylor

@Anthony Gallo
Any update on this for Gift? We still can't retrieve gift_code for list.

Alex Wong

@Stephen Taylor
gift_code is available from a gift list API call

"gift_code": {
"description": "The gift code value associated with the gift.",
"type": "string"
},

Stephen Taylor

@Alex Wong
No it isn't, not when you don't specify a gift_id and are retrieving a list of gifts.
API Reference - SKY API (blackbaud.com)

Alex Wong

@Stephen Taylor

Stephen Taylor

@Alex Wong
That's great that it says that, but you're telling me when you do a get request against this (without specifying a gift_id:

Not this: https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}

You get a gift_code in the response? Because I don't.

Alex Wong

@Stephen Taylor
Yes, as you can see in my screenshot, i am using the list gifts action, not get gift (where you have to provide a single gift system id to). and my 2nd screenshot also show that the dynamic content of gift code is from the list gifts action.

Alex Wong

You get a gift_code in the response? Because I don't.

well, i cannot be sure then. I am only speaking what is shown in the API documentation. As my org does not use the Gift Code field for anything, it is blank for all gifts. API output does not include a field that doesn't have value, so in my gift list API output I never use/seen the field.

I will do a test gift with Gift Code and report back tomorrow

Alex Wong

Tested it on real data, and you are right and the documentation is incorrectly stating the gift_code field is returned.

So either (1) documentation is incorrectly stating gift_code is returned or (2) documentation is correct, and the API has a bug that didn't returned the data. I would prefer if the fix is for (2) though =D

@Ben Wong @Heather McLean @Erik Leaver I am not sure if the best way to report documentation error is here by tagging you or if a support ticket is needed (support ticket is not great as there is no direct way to reach SKY API support, and going through regular RE support becomes a tug of war with them as they are not knowledgable on SKY API and result in a lot of explaining before they turn it into the internal team).

Stephen Taylor

@Alex Wong
I truly appreciate your follow up on this.

Anthony Gallo

@Alex Wong
The docs are definitely wrong here. The list endpoints are built off of the single endpoint when it comes to docs by default but sometimes items are missing. We will have to split the docs on this and then we can correct the lists one independently of the single endpoint. It might not be something we can get to immediately, but I have a story for us to clean this up soon.

Rachel Lien

@Anthony Gallo
Any updates on this error?

Anthony Gallo

@Rachel Lien
We still have a backlog of cleanup work that we will have to get to as some point. We have no plans to make any changes here. The work to update our documentation is still pending.

Edward Chen

@Anthony Gallo What should be done if I require the gift_code fetched in an efficient way?

I don't think iterating through all gifts to call the appropriate API is the way to go

The way I see it being done is to do a complete sync with some sort of data dump and then subscribe to webhooks. We then fetch from the appropriate endpoint everytime a gift changes or whenever a new gift comes in

Alex Wong

Use Query API will do the trick.

Alex Wong

https://community.blackbaud.com/discussion/comment/309717#Comment_309717

More specifically, you can do one of following:

• if for some reason, you like using the gift list endpoint, you can continue to do so and just have another workflow/app that issue Query API call to get gift system record id and gift code and save that data into another "file" or db table (if you use data warehouse)
• or you can just use Query API to get all the gift data you want, but will have to pay attention to any one-to-many field (i.e 1 gift > many soft credit; 1 gift > many fundraiser; etc) and issue separate Query API calls for each.