Search donors
Finds donors and organizations by last name, organization name, donor ID or keyword.
GET https://cotlet.dev/api/v1/donorperfect/donors/search
read
Runs the Lookup on the Search screen and returns the matches in the order DonorPerfect lists them. Each row has the donor ID, the type (individual or organization), the name, the city and the email, enough to tell two people with the same name apart. Use donor_id in the other tools. An empty list means no match; create_donor adds a record.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | What to look for. |
| by enum | enum | last_name, organization, donor_id or keyword. Default: last_name. |
| limit integer | integer | How many rows to return per page. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl "https://cotlet.dev/api/v1/donorperfect/donors/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY" result = client.call("donorperfect", "search_donors", {"query":"query"}) const result = await cotlet.call('donorperfect', 'search_donors', {"query":"query"}); cotlet call donorperfect search_donors --data '{"query":"query"}' Example response
{
"donors": [
{
"donor_id": 48213,
"type": "individual",
"name": "Dana Whitfield",
"city": "Portland",
"email": "dana.whitfield@example.org"
},
{
"donor_id": 50122,
"type": "individual",
"name": "Dana Whitfield",
"city": "Salem",
"email": "dwhitfield@example.com"
}
],
"next_cursor": null
}