API Call

Temi Badekale
Temi Badekale
Third Anniversary Facilitator 1
in Blackbaud Raiser's Edge NXT® APIs

Is possible to get the list of resource (Constituent, gift etc) and corresponding url vis an api call

Comments

  • Michael Tims
    Michael Tims Blackbaud Employee
    Seventh Anniversary Kudos 2 Name Dropper Participant

    Hi @Temi Badekale - No, there doesn't appear to be any API endpoints that will return the endpoint URLs for the various SKY APIs.

  • Temi Badekale
    Temi Badekale
    Third Anniversary Facilitator 1

    Thanks Michael, I have follow up question in regards to getting the schema of a resource, what is the best way of getting the complete schema of a resource. I tried making and api call to get records and limiting the number of record to one but when a particular field is null the key name is not present in the json result so I don't get the complete schema from on record

  • Ben Lambert
    Ben Lambert
    Tenth Anniversary Kudos 5 Name Dropper Participant

    There is no metadata feature in the SKY API today that will provide schemas programmatically (similar to OData). To see the schema for any given endpoint (not resource), you should look at the OpenApi definition for that endpoint, which you can get from the developer portal. That document will fully describe the shape of the endpoint parameters and request/response bodies.

Categories