Skip to navigation

Fetch a single logged donor activity, typed. Only logged activities are individually addressable; the other four timeline sources are read-only derived views.

Assistant capability: springiq_get_donor_activity. 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

donorIdstringRequired
activityIdstringRequired

Query parameters

sourceenumOptional

The origin of a donor-activity timeline item. Ordinal values are serialized into signed cursors, so existing values must not change.

Allowed values:

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.

idstring or nullOptional

The stored ID of the row the item came from (a logged activity, an email, a text message, an award or a general application). Only a logged activity’s ID opens the item on its own.

sourceenumOptional

The origin of a donor-activity timeline item. Ordinal values are serialized into signed cursors, so existing values must not change.

Allowed values:
activity_typestring or nullOptional

Activity type label (e.g. "LoggedEmail", "Email", "Sms", "Award", "GeneralApplication").

subjectstring or nullOptional

Short human-readable title for the item.

descriptionstring or nullOptional

Free-form detail (populated only for logged activities and SMS; null otherwise).

dateintegerOptional

When the activity occurred, in the tenant’s local time zone (UTC epoch seconds on the wire).

amountdouble or nullOptional

Monetary amount (logged monetary activities and awards); null otherwise.

fund_idstring or nullOptional

Fund the pledge/gift was directed toward (logged activities only); null otherwise.

is_completedbooleanOptional

Completion flag (logged monetary activities); false otherwise.

gift_acknowledgement_sentbooleanOptional

Whether a gift acknowledgement was sent (logged gifts); false otherwise.

gift_typestring or nullOptional

Gift type label (logged activities); null otherwise.

campaign_idstring or nullOptional

The stored ID of the campaign (logged monetary activities); null otherwise.

assigned_to_user_idstring or nullOptional

The stored ID of the staff member the activity is assigned to (logged activities); null otherwise.

sender_namestring or nullOptional

Sender display name (system emails only); null otherwise.

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error