List Grants
Returns a list of all grants for a given Connect. This API allows for paginating over many results.
DAF providers can use donor_account_id to filter Grant Requests associated with a specific Donor Account.
Query parameters
the id of the Connect object. This can be used to filter the grants by a specific Connect if you have more than one.
Filter grants by a specific Donor Account. Use this to retrieve all Grant Requests associated with a given donor.
the number of results to return; defaults to 10, max is 100
A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response.
Response
The response for Grants.list
Example response
{
"results": [
{
"id": "cfe09e64-6a74-4dab-a565-361185a6f248",
"userFriendlyId": "chariot-1234455",
"trackingId": "L9E182VBGP",
"workflowSessionId": "2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6",
"fundId": "daf-id",
"donor_account_id": "donor_account_01jpjenf5q6cawy43yxfcrxhct",
"externalGrantId": "897823sdjf8sfjs",
"createdAt": "2020-01-31T23:00:00Z",
"updatedAt": "2020-01-31T23:59:59Z",
"amount": 15000,
"status": "Initiated",
"feeDetail": {
"total": 1500,
"contributions": [
{
"name": "Chariot",
"amount": 1500,
"feeType": "chariot"
}
]
},
"firstName": "Warren",
"lastName": "Buffet",
"phone": "1237861020",
"email": "warrenBuffet@example.com",
"note": "Please dedicate in memory of grandma",
"statuses": [
{
"id": "cfe09e64-6a74-4dab-a565-361185a6f248",
"createdAt": "2020-01-31T23:00:00Z",
"status": "awaiting_daf_submission",
"comment": "The grant has been received by the nonprofit"
}
],
"paymentChannel": "direct"
}
]
}Changes
Changed in 8 of the 41 revisions of this API.201346
- ▲
removed the required property
codefrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the500statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the500statusresponse-required-property-removed
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status400response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status401response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status403response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status500response-media-type-name-specialized
- ○
added the required property
detailto the response with the400statusresponse-required-property-added
- ○
added the required property
detailto the response with the401statusresponse-required-property-added
- ○
added the required property
detailto the response with the403statusresponse-required-property-added
- ○
added the required property
detailto the response with the500statusresponse-required-property-added
- ○
added the required property
statusto the response with the400statusresponse-required-property-added
- ○
added the required property
statusto the response with the401statusresponse-required-property-added
- ○
added the required property
statusto the response with the403statusresponse-required-property-added
- ○
added the required property
statusto the response with the500statusresponse-required-property-added
- ○
added the required property
titleto the response with the400statusresponse-required-property-added
- ○
added the required property
titleto the response with the401statusresponse-required-property-added
- ○
added the required property
titleto the response with the403statusresponse-required-property-added
- ○
added the required property
titleto the response with the500statusresponse-required-property-added
- ○
added the required property
typeto the response with the400statusresponse-required-property-added
- ○
added the required property
typeto the response with the401statusresponse-required-property-added
- ○
added the required property
typeto the response with the403statusresponse-required-property-added
- ○
added the required property
typeto the response with the500statusresponse-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
removed the optional property
detailsfrom the response with the400statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the401statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the403statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the500statusresponse-optional-property-removed
- ●
- ○
added the optional property
details/items/debugto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the500statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the500statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the500statusresponse-optional-property-added
- ○
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status400response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status401response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status403response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status500response-property-type-changed
- ▲
removed the required property
errorfrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the500statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the500statusresponse-required-property-removed
- ○
added the optional property
detailsto the response with the400statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the401statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the403statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the500statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
added the new
canceledenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ○
removed the
cancelledenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ●
- ●
added the new
awaiting_account_approvalenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
awaiting_daf_submissionenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
cancelledenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
initiatedenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ○
added the new optional
queryrequest parameterdonor_account_idnew-optional-request-parameter
- ○
removed the
Approvedenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
Canceledenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
Completedenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
Initiatedenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PendingDonorAccountApprovalenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
Rejectedenum value from theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-removed
- ●
- ●
removed the optional property
results/items/donorAccountIdfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
results/items/donor_account_idto the response with the200statusresponse-optional-property-added
- ●
- ●
added the new
Approvedenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
PendingDonorAccountApprovalenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
Rejectedenum value to theresults/items/statuses/items/statusresponse property for the response status200response-property-enum-value-added
- ○
added the optional property
results/items/donorAccountIdto the response with the200statusresponse-optional-property-added
- ●