Skip to main content
POST
Export matching properties 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.
This is a synchronous, long-running endpoint. The response is returned once the entire export is complete, which typically takes up to 30 seconds. Set your HTTP client timeout to at least 120 seconds to avoid premature disconnects. See the Exporting Guide for best practices.

Body Parameters

array
Array of location objects defining where to export. Required unless property_ids or protocol filters are provided (max 15). Locations use OR logic — results matching any location are included.
object
Export only property list IDs, for example { "property_list_ids": [123] }.
object
Exclude property list IDs, for example { "property_list_ids": [456] }.
boolean | object
Exclude records already exported by your organization.
array
Array of filter objects. Omit or pass an empty array to export with no filters (location-only).
string[]
Field IDs to include in the CSV columns. Omit or pass an empty array for the default set.
string
Which contacts to include in the export. When set, contact columns (name, phone, email) are added to the CSV. Returned people consume people credits. Property credits are added only when selected property fields go beyond address/context.Options: owners, owners_and_family, renters, residents
string
default:"property"
Controls the export anchor type — determines what each row in the CSV represents.
  • property — One row per property. Property-only output consumes property credits. When contacts are included, people credits apply and property credits depend on the selected property fields.
  • person — One row per person. Deduplicates people across properties.
  • phone — One row per phone number.
  • email — One row per email address.
Person, phone, and email rows consume people credits. Chargeable property fields add property credits to those output shapes.
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

Find Properties export billing follows the entities included in the CSV. Property rows bill property credits. Returned contacts, contact rows, phone rows, and email rows bill people credits. Chargeable property fields in a contact-shaped export add 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 Properties endpoint first to check how many records match your filters before committing to an export.
  • For datasets under 250 records, the paginated Search Properties endpoint may be more appropriate.
  • Use the export_id in 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.