Action Custom Fields - Get all

Jay Marrero
Jay Marrero
Fourth Anniversary Participant
in Blackbaud Raiser's Edge NXT® APIs
Is there no API for a get all for actions custom fields?

Comments

  • Steven Cinquegrana
    Steven Cinquegrana
    Ninth Anniversary Kudos 2 Name Dropper Participant

    Hi Jay,


    Your question might be a little ambiguous; do you mean a list of actual Custom Fields associated with a particular Action? With all Actions? Or a list of Action Custom Field types/categories?

    Action custom field list (Single action) takes care of the first option.

    Action custom field category details takes care of the last.


    But there is currently no endpoint to tackle the second option, a list of actual Custom Fields for all Actions, so you would need to parse a list of Actions - retrieved using Action list (Single constituent) or Action list (All constituents) - and then use the Action ID to get the Custom Fields, I'd say.


    Cheers,

    Steve Cinquegrana | CEO and Principal Developer | Protégé Solutions

  • Hamish Burnett
    Hamish Burnett
    Name Dropper Facilitator 1

    @Steven Cinquegrana
    This would involve calling the api hundreds of thousands of times > definitely exceeding limit?
    Any other options?

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Hamish Burnett
    Query API will do this for you slightly easier, but not completely.

    You can do ONE Query API to get all, but may be wasteful data-wise, or ONE per action attribute (custom field) category.

  • Erwin Kristel
    Erwin Kristel
    Name Dropper Facilitator 1

    @Alex Wong

    Could you explain more on how to “do ONE Query API to get all [action custom fields]”? I've been investigating the Query API (https://developer.sky.blackbaud.com/api#api=query) as per your post and using the “Try It" feature, but I'm not seeing how to do that.

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Erwin Kristel
    first, you need to understand how to run Query API, it is very different than a traditional SKY API endpoint. There are template showcase that you can download to try.

    As for the “ONE query”. Imagine you have 3 action attribute categories.

    Query:

    • Criteria:
      • action attribute category 1 import id is not blank
      • OR action attribute category 2 import id is not blank
      • OR action attribute category 3 import id is not blank
    • Output
      • ID (constituent id, constituent system record id, action system record id)
      • each of the action attribute's info you want (import id, description, date, comment)

    For example:

    7192193a94e3ac8e62e85fbb9e473565-huge-im
    27d3ab9d976090008d13cb15dc207267-huge-im
  • Erwin Kristel
    Erwin Kristel
    Name Dropper Facilitator 1

    @Alex Wong
    It looks like we've been talking past each other - we're talking about two different things. You've been talking about the “Query” feature that's accessible via REnxt's front-end:

    e0512b0cf7ced858d86559b3be2703b2-huge-im

    However, what I (and the other posters) were talking about was API endpoints. For example, this is the endpoint for all gift custom fields:

    I'd like to find an endpoint similar to the above, except for all action custom fields. Running a front-end query is not sufficient since we need to be able to write a script to upload the results to our data warehouse that runs once a day.

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Erwin Kristel
    Hi, we are talking about the same thing. I only show the Query in webview criteria and output as how you would structure your Query API to pull the data in your application development.

  • Erwin Kristel
    Erwin Kristel
    Name Dropper Facilitator 1

    @Alex Wong
    Then can you tell me what the endpoint is or provide a link to endpoint documentation?

    I've looked at this documentation, but none of those endpoints are for a GET request that returns query results.

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Erwin Kristel
    to execute a query using adhoc created JSON query definition: https://developer.sky.blackbaud.com/api#api=query&operation=StartQueryExecutionJob

    to execute a query using a saved RE NXT query by it's ID: https://developer.sky.blackbaud.com/api#api=query&operation=StartQueryExecutionJobByID

    From the above 2 endpoints, you will get a JOB ID, which is needed to issue the get job status endpoint: https://developer.sky.blackbaud.com/api#api=query&operation=GetJob

    You will need to wait for query job to finish running, which can take a variable amount of time, start checking job status every 30 seconds to receive a downloadable URL that can be use to download a CSV or JSON (or JSONL) based on what you specified in the query execution.

    If you don't know how to use Query API (or adhoc querying) there are template showcase that you can download and try.

Categories