Sign in
recurring_grants

Get Recurring Grant

Retrieve a recurring grant with a given ID.

get/v1/recurring_grants/{id}

Path parameters

idstring uuid required

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

Response

OK

idstring uuid required

The unique identifier for the object

trackingIdstring

The tracking ID for the grant

workflowSessionIdstring uuid required

ID of the Connect Workflow Session associated with this grant

fundIdstring required

ID of the donor advised fund

frequency'MONTHLY' required

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

externalRecurringGrantIdstring

ID of the grant associated with the donor advised fund

createdAtstring date-time

Time when this object was created; expressed in RFC 3339 format

updatedAtstring date-time

Time when this object was last updated; expressed in RFC 3339 format

amountnumber required

The grant amount expressed in units of whole cents

firstNamestring

The donor's first name

lastNamestring

The donor's last name

phonestring

The donor's phone number

emailstring

The donor's email

notestring

An note inputted by the user at submisson

Example response

{
  "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
  "trackingId": "L9E182VBGP",
  "workflowSessionId": "2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6",
  "fundId": "daf-id",
  "frequency": "MONTHLY",
  "externalRecurringGrantId": "897823sdjf8sfjs",
  "createdAt": "2020-01-31T23:00:00Z",
  "updatedAt": "2020-01-31T23:59:59Z",
  "amount": 15000,
  "firstName": "Warren",
  "lastName": "Buffet",
  "phone": "1237861020",
  "email": "warrenBuffet@example.com",
  "note": "Please dedicate in memory of grandma"
}

Changes

Changed in 4 of the 41 revisions of this API.25545

  • b87f7738d3361025See the full diff
    • ▲

      removed the required property code from the response with the 400 status

      response-required-property-removed

    • ▲

      removed the required property code from the response with the 401 status

      response-required-property-removed

    • ▲

      removed the required property code from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property code from the response with the 404 status

      response-required-property-removed

    • ▲

      removed the required property code from the response with the 500 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 400 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 401 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 404 status

      response-required-property-removed

    • ▲

      removed the required property message from the response with the 500 status

      response-required-property-removed

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 400

      response-media-type-name-specialized

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 401

      response-media-type-name-specialized

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 403

      response-media-type-name-specialized

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 404

      response-media-type-name-specialized

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 500

      response-media-type-name-specialized

    • ○

      added the required property detail to the response with the 400 status

      response-required-property-added

    • ○

      added the required property detail to the response with the 401 status

      response-required-property-added

    • ○

      added the required property detail to the response with the 403 status

      response-required-property-added

    • ○

      added the required property detail to the response with the 404 status

      response-required-property-added

    • ○

      added the required property detail to the response with the 500 status

      response-required-property-added

    • ○

      added the required property status to the response with the 400 status

      response-required-property-added

    • ○

      added the required property status to the response with the 401 status

      response-required-property-added

    • ○

      added the required property status to the response with the 403 status

      response-required-property-added

    • ○

      added the required property status to the response with the 404 status

      response-required-property-added

    • ○

      added the required property status to the response with the 500 status

      response-required-property-added

    • ○

      added the required property title to the response with the 400 status

      response-required-property-added

    • ○

      added the required property title to the response with the 401 status

      response-required-property-added

    • ○

      added the required property title to the response with the 403 status

      response-required-property-added

    • ○

      added the required property title to the response with the 404 status

      response-required-property-added

    • ○

      added the required property title to the response with the 500 status

      response-required-property-added

    • ○

      added the required property type to the response with the 400 status

      response-required-property-added

    • ○

      added the required property type to the response with the 401 status

      response-required-property-added

    • ○

      added the required property type to the response with the 403 status

      response-required-property-added

    • ○

      added the required property type to the response with the 404 status

      response-required-property-added

    • ○

      added the required property type to the response with the 500 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c65f43c5ad905See the full diff
    • ●

      removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 500 status

      response-optional-property-removed

  • f89b4f376e9415See the full diff
    • ○

      added the optional property details/items/debug to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details/items/debug to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property details/items/debug to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property details/items/debug to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details/items/debug to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property details/items/type to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details/items/type to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property details/items/type to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property details/items/type to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details/items/type to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property details/items/value to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details/items/value to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property details/items/value to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property details/items/value to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details/items/value to the response with the 500 status

      response-optional-property-added

  • 90671617b825155See the full diff
    • ▲

      the code response's property type/format changed from number/ to string/ for status 400

      response-property-type-changed

    • ▲

      the code response's property type/format changed from number/ to string/ for status 401

      response-property-type-changed

    • ▲

      the code response's property type/format changed from number/ to string/ for status 403

      response-property-type-changed

    • ▲

      the code response's property type/format changed from number/ to string/ for status 404

      response-property-type-changed

    • ▲

      the code response's property type/format changed from number/ to string/ for status 500

      response-property-type-changed

    • ▲

      removed the required property error from the response with the 400 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 401 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 404 status

      response-required-property-removed

    • ▲

      removed the required property error from the response with the 500 status

      response-required-property-removed

    • ▲

      removed the required property timestamp from the response with the 400 status

      response-required-property-removed

    • ▲

      removed the required property timestamp from the response with the 401 status

      response-required-property-removed

    • ▲

      removed the required property timestamp from the response with the 403 status

      response-required-property-removed

    • ▲

      removed the required property timestamp from the response with the 404 status

      response-required-property-removed

    • ▲

      removed the required property timestamp from the response with the 500 status

      response-required-property-removed

    • ○

      added the optional property details to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 500 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog