Search Constituent by email address

Liz Anderson
Liz Anderson
Fourth Anniversary
in Blackbaud Raiser's Edge NXT® APIs
Hello, 


I'm a little confused by the documentation. Can we only search constituents using the lookup_id as the search field? Or should we be able to make the search field set as 'email' or 'name'? The problem I'm facing is that I need to find the constituent ID based off email addresses (maybe first/last name could be plan B), is this possible?


Thank you,

Liz

Comments

  • Kendrah Richards
    Kendrah Richards
    Eighth Anniversary Name Dropper Participant Facilitator 1
    You can look up a constituent by their email address.  I do this by not typing in the whole email just in case you miss a letter or number.  Use the "*" feature and type some of the email and you should be able to look them up.  You will have to click on the magnifying goggles or the advanced search so you get to the point where you have the email field to search.  Good luck!
  • Ben Lambert
    Ben Lambert
    Ninth Anniversary Kudos 5 Name Dropper Participant
    Hi Liz,


    Yes, you can use the SearchConstituent endpoint in the Constituent SKY API to find a constituent by email address.  Just set the search_text parameter to the email address you have, no need to set search_field (which only supports lookup_ID at the moment and is used to optimize the search logic when searching by lookup ID). 


    The way this endpoint works is, if the incoming search text looks like an email address (based on a regex pattern), it will look at constituent email addresses.


    In case you haven't tried it, you can play around with the endpoint behavior using the "Try It" button in the SKY API Console.


    Hope this helps - please let us know if you have any questions!

     

Categories