How can I retrieve all constituents from the Altru API?

Ana Cabrera
Ana Cabrera
Name Dropper First Anniversary Facilitator 1
in SKY Developer General Discussions

I need to retrieve all organizations, households, and contacts using the Altru API. It has been challenging to obtain this data from the SKY API. We are currently using the 'Search for Constituent' endpoint, but it doesn't retrieve all constituents that appear in a report. For instance, the API returns 1000 records, whereas the report returns 4900 records. We are uncertain if the endpoint is correct

Comments

  • Ashley Moose
    Ashley Moose Blackbaud Employee
    Ninth Anniversary Kudos 5 First Reply Name Dropper

    @Ana Cabrera The Constituent Search endpoint will only return a limit of 1000 results. If you are looking to get a list of all constituents, I would recommend creating a constituent query with no criteria and then call that query ID in the List adhoc query entries endpoint to view all of the query results.

    You can either include additional constituent fields in the output of the query to also view those in the response, or then iterate through the Get an individual or Get an organization endpoints by referencing the ID returned for each constituent in the response.

Categories