---
title: "List Grants"
method: GET
path: "/v1/grants"
tags: ["Grants"]
---

# List Grants

`GET /v1/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](/api/donor-accounts).

## Query parameters

- `connect_id` string
- `donor_account_id` string
- `pageLimit` integer
- `pageToken` string

## Response `200`

The response for Grants.list

- object
  - `results` Grant[]
    - `id` string, uuid, required — The unique identifier for the object
    - `userFriendlyId` string — Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.
    - `trackingId` string — The tracking ID for the grant
    - `workflowSessionId` string, uuid, required — ID of the Connect Workflow Session associated with this grant
    - `fundId` string, required — ID of the donor advised fund
    - `donor_account_id` string — ID of the [Donor Account](/api/donor-accounts) that this grant was submitted from. Present on grants submitted by donors who authenticated through the DAFpay Donor Account flow. Grants submitted without a linked Donor Account will not have this field set.
    - `externalGrantId` string — ID of the grant associated with the donor advised fund
    - `createdAt` string, date-time — Time when this object was created; expressed in RFC 3339 format
    - `updatedAt` string, date-time — Time when this object was last updated; expressed in RFC 3339 format
    - `amount` number, required — The grant amount expressed in units of whole cents
    - `status` string — The status of the grant
    - `feeDetail` object — The fee detail of the grant
      - `total` number — The total fee amount expressed in units of cents
      - `contributions` ContributionFeeDetail[] — The list of fee contributions for this grant
        - `name` string, required — The name of the party charging the fee. This is an informational field. If you need to differentiate between fees charged by different parties, you should use the `feeType` field.
        - `amount` number, required — The fee contribution amount expressed in units of cents
        - `feeType` 'chariot' | 'daf' | 'fundraising_application' — This indicates the source of a fee contribution. * chariot: Chariot's processing fee * daf: The DAF's processing fee * fundraising_application: The fundraising application's processing fee
    - `metadata` object — A map of arbitrary string keys and values to store information about the object
    - `firstName` string — The donor's first name
    - `lastName` string — The donor's last name
    - `phone` string — The donor's phone number
    - `email` string — The donor's email
    - `note` string — An note inputted by the user at submisson
    - `statuses` GrantStatus[] — The list of grant statuses for this grant
      - `id` string, uuid, required — The unique identifier for the object
      - `createdAt` string, date-time, required — Time when this object was created; expressed in RFC 3339 format
      - `status` 'awaiting_account_approval' | 'awaiting_daf_submission' | 'initiated' | 'canceled', required — The status of the grant. * awaiting_account_approval: The linked Donor Account is not yet `approved`. The grant advances automatically when the Account is approved. * awaiting_daf_submission: The Account is approved and the grant is ready for the DAF to submit in their system. * initiated: The DAF has submitted the grant. Terminal. * canceled: The DAF has canceled the grant. Terminal.
      - `comment` string — The user comment for the update
    - `paymentChannel` 'dafpay_network' | 'direct' — The payment channel for the grant. This is useful to know how the grant will be sent. The payment channel will be one of the following: - dafpay_network: Grant will be sent to the DAFPay Network 501(c)(3) nonprofit organization (EIN: 93-1372175). The DAFPay Network will then review and process the grant and send the funds to the intended recipient. - direct: Grant will be sent directly to the intended recipient.
    - `address` GrantAddress
      - `line1` string — Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters.
      - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters.
      - `city` string — City, district, suburb, town, or village.. Maximum length: 255 characters.
      - `state` string — State, county, province, or region. Maximum length: 255 characters.
      - `postalCode` string — ZIP or postal code. Maximum length: 255 characters.
  - `nextPageToken` string, 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.

## Other responses

- `400` — The request is invalid or contains invalid parameters
- `401` — Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller.
- `403` — Access denied
- `500` — Internal Server Error

---

[API](https://skmtc.net/chariot-giving/apis/chariot-api.md) · [All operations](https://skmtc.net/chariot-giving/apis/chariot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chariot-giving/chariot-api/versions/dc28cadc066e/schema)