List Grants
Changed onReturns 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.
Request
- Base URLhttps://sandboxapi.givechariot.com
- URLhttps://sandboxapi.givechariot.com/v1/grants
- AuthHTTP bearer
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.
Filter grants by the id of a specific Donation. Use this to retrieve the grant behind a donation you already have.
Filter grants by their DAFpay tracking ID. Use this to find the grant behind a tracking ID you already have.
Filter grants by the ID the donor advised fund gave the grant. Use this to find the grant behind a DAF's grant ID.
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",
"donation_id": "donation_01j8rs605a4gctmbm58d87mvsj",
"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
- info
added the new optional
queryrequest parameterexternal_grant_id - info
added the new optional
queryrequest parametertracking_id
- info