DAFpayGrants

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

connect_idstringOptional

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_idstringOptional

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

pageLimitintegerOptionalDefaults to 10

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

The response for Grants.list
resultslist of objects
nextPageTokenstring or null

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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error