For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

DonorAtlas Dashboard

Getting Started
Guides
API Reference

DonorAtlas Dashboard

API Reference Lists

Get single list metadata

GET

https://api.donoratlas.com/v1/partners/lists/:list_id

GET

/v1/partners/lists/:list_id

$ curl https://api.donoratlas.com/v1/partners/lists/list_id \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "list_data": {
3     "list_id": "a1b2c3d4e5f6g7h8i9j0",
4     "list_name": "Annual Gala Donors 2024",
5     "donor_count": 1523,
6     "date_created": "2023-11-01T09:15:00Z",
7     "date_updated": "2024-04-20T16:45:30Z",
8     "editable": true,
9     "removable": true
10   }
11 }

Get metadata for a single donor list by ID.

Was this page helpful?

Rename a list

Authentication

x-api-keystring

Your DonorAtlas API key. Contact support@donoratlas.com to get started.

Path parameters

list_idstringRequired1-100 characters

ID of the list to retrieve

Response

Successful Response

list_dataobject

Metadata for the requested list

Errors

404

Not Found Error

422

Unprocessable Entity Error