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.
DonorAtlasDashboard
  • Getting Started
    • Welcome
    • Authentication
    • Quickstart
  • Guides
    • Donor Profile Schema
    • Network
    • Credits & Billing
    • Error Handling
  • API Reference
      • POSTCreate a new donor list
      • GETGet all lists metadata
      • GETGet single list metadata
      • PATCHRename a list
      • DELDelete a list
      • POSTAdd donors to a list
      • POSTRemove donors from a list
LogoLogo
DonorAtlasDashboard
API ReferenceLists

Get all lists metadata

GET
https://api.donoratlas.com/v1/partners/lists
GET
/v1/partners/lists
$curl https://api.donoratlas.com/v1/partners/lists \
> -H "x-api-key: <apiKey>" \
> -H "Content-Type: application/json"
200Retrieved
1{
2 "lists": [
3 {
4 "list_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5 "list_name": "Annual Gala Donors",
6 "donor_count": 152,
7 "date_created": "2023-11-01T09:15:00Z",
8 "date_updated": "2024-05-20T16:45:00Z",
9 "editable": true,
10 "removable": true
11 },
12 {
13 "list_id": "f0e9d8c7-b6a5-4321-0fed-cba987654321",
14 "list_name": "All Saved Donors",
15 "donor_count": 1245,
16 "date_created": null,
17 "date_updated": "2024-06-10T12:00:00Z",
18 "editable": false,
19 "removable": false
20 }
21 ]
22}
Get metadata for all donor lists belonging to the team, including the virtual 'All Saved Donors' list.
Was this page helpful?
Previous

Get single list metadata

Next
Built with

Authentication

x-api-keystring

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

Response

Successful Response
listslist of objects
Metadata for all lists belonging to the team