CHchariot-giving
unintegrated_grants

List Unintegrated Grants

Changed on

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

get/v1/unintegrated_grants

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/unintegrated_grants
  • Auth
    HTTP bearer

Query parameters

connect_idstring

the id of the Connect object. This can be used to filter the unintegrated grants by a specific Connect if you have more than one.

tracking_idstring

Filter unintegrated grants by their DAFpay tracking ID. Use this to find the unintegrated grant behind a tracking ID you already have.

pageLimitinteger

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

pageTokenstring

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 UnintegratedGrants.list

nextPageTokenstring

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.

Example response

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

Changes