Export people to CSV or XLSX | WealthAtlas Partners API

Export person data to a file. Provide either a list ID or specific person IDs as the source. Specify the fields to include (see the DASpreadsheetFieldName enum for valid values). All exports run synchronously and return a presigned download URL.

Cost: 1 credit per person exported.

Authentication

x-api-keystring

Your WealthAtlas API key. Contact support@wealthatlas.com to get started.

Request

This endpoint expects an object.

sourceobjectRequired

Export source — either a list ID or specific person IDs

export_typeenumRequired

Export format: ‘csv’ or ‘xlsx’

fieldslist of nullable enumsRequired

Fields to include in the export

Response

Successful Response

export_idstring

Unique export identifier

credits_chargedinteger

Number of Partner API export credits consumed

exports_credits_remaininginteger or string

Export credits remaining after this export, or "unlimited"

download_urlstring or nullOptional

Presigned download URL

Errors

400

Bad Request Error

402

Payment Required Error

422

Unprocessable Entity Error

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

1	{
2	"export_id": "string",
3	"credits_charged": 1,
4	"exports_credits_remaining": 1,
5	"download_url": "string"
6	}