> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.wealthatlas.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.wealthatlas.com/_mcp/server. # Export people to CSV or XLSX POST https://api.wealthatlas.com/v1/partners/exports Content-Type: application/json 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.** Reference: https://developer.wealthatlas.com/api-reference/export/create-export ## Authentication - `x-api-key` header (required) — Your WealthAtlas API key. Contact support@wealthatlas.com to get started. ## Request ### Body (application/json) This endpoint expects an ExportRequest. - `source` (ExportRequestSource, required) — Export source — either a list ID or specific person IDs - `export_type` (enum, required) — Export format: 'csv' or 'xlsx' - Allowed values: `csv`, `xlsx` - `fields` (list of enum, required) — Fields to include in the export - Allowed values: `DonorAtlas URL`, `Title`, `First`, `Middle`, `Last`, `Suffix`, `Sex`, `Mailing Address`, `City`, `State`, `Zipcode`, `Verified Mobile Phone`, `Best Verified Email`, `Verified Personal Emails`, `Verified Work Emails`, `Other Emails`, `Other Phones`, `Age`, `Religion`, `Top Issues`, `Bio`, `Political Giving Capacity`, `Total Political Giving`, `Nonprofit Largest Gift (Max)`, `Nonprofit Average Gift`, `Nonprofit Years Active`, `Predicted Annual Giving`, `Net Worth (Min)`, `Net Worth (Max)`, `Liquidity (Min)`, `Liquidity (Max)`, `Most Recent School`, `All Schools`, `Most Recent Employer`, `All Employers`, `Nonprofit Boards`, `Research Links`, `Notes`, `Private Foundations`, `Spouse`, `Parents`, `Children` ## Response ### 201 Successful Response - `export_id` (string, required) — Unique export identifier - `credits_charged` (integer, required) — Number of Partner API export credits consumed - `exports_credits_remaining` (ExportResponseExportsCreditsRemaining, required) — Export credits remaining after this export, or "unlimited" - `download_url` (string, optional, nullable) — Presigned download URL ## Errors ### 400 Bad Request Error List is empty, does not exist, no person IDs provided, or fields are invalid - `any` ### 402 Payment Required Error Out of credits in the bucket this endpoint charges (buckets are strictly isolated) - `error` (string, required) - `message` (string, required) - `bucket` (string, required) — The credit bucket that was exhausted - `available_credits` (integer, required) ### 422 Unprocessable Entity Error Validation error (missing fields, invalid types) - `any` ## Types ### ExportRequestSource Export source — either a list ID or specific person IDs - `type`: `ids` (ids) - `person_ids` (list of string, required) — Specific person IDs to export - `type`: `list` (list) - `list_id` (string, required) — ID of a person list to export ### ExportResponseExportsCreditsRemaining Export credits remaining after this export, or "unlimited" - integer - string ## Examples **Request** ```json { "source": { "list_id": "string" }, "export_type": "csv", "fields": [ "First", "Last", "Best Verified Email", "City", "State", "Zipcode" ] } ``` **Response** ```json { "export_id": "string", "credits_charged": 1, "exports_credits_remaining": 1, "download_url": "string" } ``` **SDK Code** ```python import requests url = "https://api.wealthatlas.com/v1/partners/exports" payload = { "source": { "list_id": "string" }, "export_type": "csv", "fields": ["First", "Last", "Best Verified Email", "City", "State", "Zipcode"] } headers = { "x-api-key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.wealthatlas.com/v1/partners/exports'; const options = { method: 'POST', headers: {'x-api-key': '', 'Content-Type': 'application/json'}, body: '{"source":{"list_id":"string"},"export_type":"csv","fields":["First","Last","Best Verified Email","City","State","Zipcode"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.wealthatlas.com/v1/partners/exports" payload := strings.NewReader("{\n \"source\": {\n \"list_id\": \"string\"\n },\n \"export_type\": \"csv\",\n \"fields\": [\n \"First\",\n \"Last\",\n \"Best Verified Email\",\n \"City\",\n \"State\",\n \"Zipcode\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("x-api-key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.wealthatlas.com/v1/partners/exports") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["x-api-key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"source\": {\n \"list_id\": \"string\"\n },\n \"export_type\": \"csv\",\n \"fields\": [\n \"First\",\n \"Last\",\n \"Best Verified Email\",\n \"City\",\n \"State\",\n \"Zipcode\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.wealthatlas.com/v1/partners/exports") .header("x-api-key", "") .header("Content-Type", "application/json") .body("{\n \"source\": {\n \"list_id\": \"string\"\n },\n \"export_type\": \"csv\",\n \"fields\": [\n \"First\",\n \"Last\",\n \"Best Verified Email\",\n \"City\",\n \"State\",\n \"Zipcode\"\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.wealthatlas.com/v1/partners/exports', [ 'body' => '{ "source": { "list_id": "string" }, "export_type": "csv", "fields": [ "First", "Last", "Best Verified Email", "City", "State", "Zipcode" ] }', 'headers' => [ 'Content-Type' => 'application/json', 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.wealthatlas.com/v1/partners/exports"); var request = new RestRequest(Method.POST); request.AddHeader("x-api-key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"source\": {\n \"list_id\": \"string\"\n },\n \"export_type\": \"csv\",\n \"fields\": [\n \"First\",\n \"Last\",\n \"Best Verified Email\",\n \"City\",\n \"State\",\n \"Zipcode\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-api-key": "", "Content-Type": "application/json" ] let parameters = [ "source": ["list_id": "string"], "export_type": "csv", "fields": ["First", "Last", "Best Verified Email", "City", "State", "Zipcode"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.wealthatlas.com/v1/partners/exports")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```