List Donor Accounts

Returns a list of Donor Accounts for the authenticated DAF. This endpoint supports cursor-based pagination as well as filtering by fund, status, and email.

Authentication

AuthorizationBearer

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

Query parameters

giving_pool_idstringOptional

The id of a Giving Pool. When set, filters Donor Accounts to those that have this Giving Pool associated with them.

statusenumOptional
Filter Donor Accounts to only those with the specified status.
Allowed values:
emailstringOptional
Filter Donor Accounts by donor email. The match is case insensitive and exact.
external_idstringOptional

Filter Donor Accounts by external_id — the DAF’s internal identifier for the Donor Account.

page_limitintegerOptionalDefaults to 10

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

page_tokenstringOptional

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 next_page_token in the previous response.

Response

The response for DonorAccounts.list
resultslist of objects
next_page_tokenstring 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 page_token). 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