Export donors to CSV or XLSX | DonorAtlas Partners API

curl -X POST https://api.donoratlas.com/v1/partners/exports \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "source": {
    "list_id": "list_9f8b7c6d5e4a3b2c1d0e"
  },
  "export_type": "csv",
  "fields": [
    "First",
    "Last",
    "Best Verified Email",
    "City",
    "State",
    "DonorAtlas URL"
  ]
}'

{
  "export_id": "exp_1234567890abcdef",
  "credits_used": 25,
  "exports_remaining": 75,
  "download_url": "https://s3.amazonaws.com/donoratlas-exports/exp_1234567890abcdef.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000Z&X-Amz-Expires=3600&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890&X-Amz-SignedHeaders=host"
}

Export donor data to a file. Provide either a list ID or specific donor IDs as the source. Specify the fields to include (see the DASpreadsheetFieldName enum for valid values). Export credits are consumed per unique donor exported (re-exporting the same donor is free). All exports run synchronously and return a presigned download URL.

curl -X POST https://api.donoratlas.com/v1/partners/exports \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "source": {
    "list_id": "list_9f8b7c6d5e4a3b2c1d0e"
  },
  "export_type": "csv",
  "fields": [
    "First",
    "Last",
    "Best Verified Email",
    "City",
    "State",
    "DonorAtlas URL"
  ]
}'

{
  "export_id": "exp_1234567890abcdef",
  "credits_used": 25,
  "exports_remaining": 75,
  "download_url": "https://s3.amazonaws.com/donoratlas-exports/exp_1234567890abcdef.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000Z&X-Amz-Expires=3600&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890&X-Amz-SignedHeaders=host"
}

Authentication

x-api-keystring

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

Request

This endpoint expects an object.

sourceobjectRequired

Export source — either a list ID or specific donor IDs

export_typeenumRequired

Export format: ‘csv’ or ‘xlsx’

Allowed values:

fieldslist of nullable enumsRequired

Fields to include in the export

Response

Successful Response

export_idstring

Unique export identifier

credits_usedinteger

Number of export credits consumed

exports_remaininginteger

Export credits remaining after this export

download_urlstring or null

Presigned download URL

Errors

400

Bad Request Error

402

Payment Required Error

422

Unprocessable Entity Error

$	curl -X POST https://api.donoratlas.com/v1/partners/exports \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"source": {
>	"list_id": "list_9f8b7c6d5e4a3b2c1d0e"
>	},
>	"export_type": "csv",
>	"fields": [
>	"First",
>	"Last",
>	"Best Verified Email",
>	"City",
>	"State",
>	"DonorAtlas URL"
>	]
>	}'

1	{
2	"export_id": "exp_1234567890abcdef",
3	"credits_used": 25,
4	"exports_remaining": 75,
5	"download_url": "https://s3.amazonaws.com/donoratlas-exports/exp_1234567890abcdef.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000Z&X-Amz-Expires=3600&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890&X-Amz-SignedHeaders=host"
6	}