Get Recurring Grant

GET
/v1/recurring_grants/:id

Retrieve a recurring grant with a given ID.

Path parameters

idstringRequired

The unique id of the recurring grant. The format should be a v4 UUID according to RFC 4122.

Response

This endpoint returns an object.
idstring

The unique identifier for the object

workflowSessionIdstring

ID of the Connect Workflow Session associated with this grant

fundIdstring

ID of the donor advised fund

frequency"MONTHLY"

How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency.

amountdouble

The grant amount expressed in units of whole cents

trackingIdstringOptional

The tracking ID for the grant

externalGrantIdstringOptional

ID of the grant associated with the donor advised fund

createdAtdatetimeOptional

Time when this object was created; expressed in ISO 8601 format

updatedAtdatetimeOptional

Time when this object was last updated; expressed in ISO 8601 format

firstNamestringOptional

The donor’s first name

lastNamestringOptional

The donor’s last name

phonestringOptional

The donor’s phone number

emailstringOptional

The donor’s email

notestringOptional

An note inputted by the user at submisson

addressobjectOptional

Errors