People
Export People
POST
Export matching people as a compressed CSV file. Returns signed download URLs that you can use to download the exported data. This endpoint is designed for bulk data extraction — up to 1,000,000 records per export.
Each object in the
Body Parameters
array
Array of location objects defining where to export. Required unless
people_ids or protocol filters are provided (max 15). Locations use OR logic — results matching any location are included.object
Export only people list IDs, for example
{ "people_list_ids": [123] }.object
Exclude people list IDs, for example
{ "people_list_ids": [456] }.boolean | object
Exclude people already exported by your organization.
array
Array of filter objects. Omit or pass an empty array to export with no filters (location-only).
string
Defines the person-to-property relationship for the export.Options:
owner, resident, renterstring
default:"person"
Controls what each CSV row represents. Use
person for one row per person (default), phone for one row per phone number, or email for one row per email address.boolean
Only include records where the contact has a phone number. Useful for telemarketing or outreach
campaigns.
boolean
Only include records where the contact has an email address. Useful for email marketing campaigns.
boolean
Only include wireless phone numbers. Cannot be combined with
landline_only.boolean
Only include landline phone numbers. Cannot be combined with
mobile_only.boolean
Exclude contacts on the Do Not Call registry. Recommended for compliance with telemarketing
regulations.
Response
People, phone, and email exports from Find People charge people data credits per distinct contact.
Associated properties included in the output consume property credits.
download_urls
Each object in the download_urls array contains:
Exported files are gzip-compressed CSV (
.csv.gz). Most tools (Excel, Google Sheets, Python
pandas) can open .csv.gz files directly. To decompress manually, use gunzip or any archive
tool.Tips
- Use the Count People endpoint first to check how many records match your filters before committing to an export.
- For datasets under 250 records, the paginated Search People endpoint may be more appropriate.
- People exports are deduplicated — each unique person appears only once in the CSV, even if they match multiple properties.
- Use the
export_idin the response with Get Export to retrieve download URLs later, or List Exports to browse past exports. - See the Exporting Guide for timeout configuration, download handling, and best practices.