List Grants

GET

/v1/grants

Returns a list of all grants for a given Connect. This API allows for paginating over many results.

Headers

x-chariot-api-keystringRequired

the apiKey of the Connect object

Query parameters

pageLimitintegerOptional

the number of results to return; defaults to 10, max is 100

pageTokenstringOptional

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

This endpoint returns an object.

resultslist of objectsOptional

nextPageTokenstringOptional

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Errors

GET

1 curl https://api.givechariot.com/v1/grants \
2      -H "x-chariot-api-key: live_xJd0lUrvpDkzeGBWZbuI2wbvEdM" \
3      -H "Authorization: Bearer <token>"

1 {
2   "results": [
3     {
4       "id": "1e60800e-849b-43d1-870e-57afc8d75473",
5       "workflowSessionId": "cfe09e64-6a74-4dab-a565-361185a6f248",
6       "fundId": "daf-id",
7       "amount": 15000,
8       "trackingId": "L9E182VBGP",
9       "externalGrantId": "897823sdjf8sfjs",
10       "createdAt": "2021-08-10T15:00:00Z",
11       "updatedAt": "2021-08-11T15:34:00Z",
12       "status": "Initiated",
13       "feeDetail": {
14         "total": 1500,
15         "contributions": [
16           {
17             "name": "Chariot",
18             "amount": 1500
19           }
20         ]
21       },
22       "metadata": {
23         "key": "value"
24       },
25       "firstName": "Warren",
26       "lastName": "Buffet",
27       "phone": "1237861020",
28       "email": "warrenBuffet@example.com",
29       "note": "Please dedicate in memory of grandma",
30       "statuses": [
31         {
32           "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
33           "createdAt": "2020-07-10T15:00:00Z",
34           "status": "Initiated",
35           "comment": "The grant has been received by the nonprofit"
36         }
37       ],
38       "paymentChannel": "dafpay_network",
39       "userFriendlyId": "chariot-1234455"
40     }
41   ],
42   "nextPageToken": "c3f685f2-2dda-4956-815b-39867a5e5638"
43 }

Built with

1	curl https://api.givechariot.com/v1/grants \
2	-H "x-chariot-api-key: live_xJd0lUrvpDkzeGBWZbuI2wbvEdM" \
3	-H "Authorization: Bearer <token>"

1	{
2	"results": [
3	{
4	"id": "1e60800e-849b-43d1-870e-57afc8d75473",
5	"workflowSessionId": "cfe09e64-6a74-4dab-a565-361185a6f248",
6	"fundId": "daf-id",
7	"amount": 15000,
8	"trackingId": "L9E182VBGP",
9	"externalGrantId": "897823sdjf8sfjs",
10	"createdAt": "2021-08-10T15:00:00Z",
11	"updatedAt": "2021-08-11T15:34:00Z",
12	"status": "Initiated",
13	"feeDetail": {
14	"total": 1500,
15	"contributions": [
16	{
17	"name": "Chariot",
18	"amount": 1500
19	}
20	]
21	},
22	"metadata": {
23	"key": "value"
24	},
25	"firstName": "Warren",
26	"lastName": "Buffet",
27	"phone": "1237861020",
28	"email": "warrenBuffet@example.com",
29	"note": "Please dedicate in memory of grandma",
30	"statuses": [
31	{
32	"id": "cfe09e64-6a74-4dab-a565-361185a6f248",
33	"createdAt": "2020-07-10T15:00:00Z",
34	"status": "Initiated",
35	"comment": "The grant has been received by the nonprofit"
36	}
37	],
38	"paymentChannel": "dafpay_network",
39	"userFriendlyId": "chariot-1234455"
40	}
41	],
42	"nextPageToken": "c3f685f2-2dda-4956-815b-39867a5e5638"
43	}