Skip to navigation
API ReferenceDonors

Get a donor.

Includes giving totals for the donor’s lifetime and the current year, their most recent gift, and their notes. id is the donor’s stored ID. Returns 404 donor_not_found naming id if no such donor belongs to this institution.

Assistant capability: springiq_get_donor_profile. Required permission: Donors (applies when called on behalf of a signed-in person).

Authentication

X-Spring-API-Keystring
Secret API key issued per institution. Send it on every request.

Path parameters

idstringRequired

Response

OK
objectstring or nullOptionalRead-only

Stripe-style resource discriminator. Stable, snake_case string naming the resource type. Serialized first so it reads as the leading field of every V1 resource body.

quick_statsobjectOptional
idstring or nullOptional

The donor’s stored ID: 9 characters, sent exactly as stored. A dry-run create returns null, because no donor was saved.

first_namestring or nullOptional
last_namestring or nullOptional
emailstring or nullOptional
phonestring or nullOptional
roleenum or nullOptional

Whether this is an individual donor or a donor organization: Individual or Organization. Mirrors the role field on the create request.

Allowed values:
date_of_birthinteger or nullOptional
birth_monthstring or nullOptional
birth_dayinteger or nullOptional
birth_yearinteger or nullOptional
address1string or nullOptional
address2string or nullOptional
citystring or nullOptional
statestring or nullOptional
countystring or nullOptional
zip_codestring or nullOptional
countryinteger or nullOptional
job_titlestring or nullOptional
work_emailstring or nullOptional
work_phonestring or nullOptional
company_namestring or nullOptional
organization_namestring or nullOptional
public_organization_namestring or nullOptional
make_profile_privateboolean or nullOptional
public_first_namestring or nullOptional
public_last_namestring or nullOptional
websitestring or nullOptional
facebook_urlstring or nullOptional
twitter_urlstring or nullOptional
linked_in_urlstring or nullOptional
photo_urlstring or nullOptional
descriptionstring or nullOptional
notesstring or nullOptional
include_soft_creditsbooleanOptional

Errors

403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error