Grants

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.

get/v1/grants

Query parameters

connect_idstring

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

donor_account_idstring

Filter grants by a specific Donor Account. Use this to retrieve all Grant Requests associated with a given donor.

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

nextPageTokenstring nullable

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": "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

  • b87f7738d336820See 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 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 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 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 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 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 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 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

    • 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 500 status

      response-optional-property-removed

    • 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 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 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 500 status

      response-optional-property-added

  • 90671617b825124See 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 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 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 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 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

  • 412b6fc0ed4e11See the full diff
    • added the new canceled enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • removed the cancelled enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

  • e82b2918c9fb47See the full diff
    • added the new awaiting_account_approval enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new awaiting_daf_submission enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new cancelled enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new initiated enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new optional query request parameter donor_account_id

      new-optional-request-parameter

    • removed the Approved enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Canceled enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Completed enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Initiated enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the PendingDonorAccountApproval enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Rejected enum value from the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the optional property results/items/donorAccountId from the response with the 200 status

      response-optional-property-removed

    • added the optional property results/items/donor_account_id to the response with the 200 status

      response-optional-property-added

    • added the new Approved enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new PendingDonorAccountApproval enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new Rejected enum value to the results/items/statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the optional property results/items/donorAccountId to the response with the 200 status

      response-optional-property-added