Import

Bulk import data from CSV/spreadsheet files into the system.

📄️ Add Import

Initiates a new import job and returns a pre-signed URL to upload the file. Use CSV for most entities, or KML/KMZ for Area. Upload Area files with Content-Type: application/octet-stream; upload CSV files with Content-Type: text/csv. After upload, processing begins automatically. CSV files support at most 500 columns, including unmapped columns. Account imports reject files with more than 5,000 rows missing latitude or longitude, regardless of disableGeocoding. Records are split into batches and processed through a shared queue with controlled parallelism. Splitting files does not increase worker capacity, and completion times can vary with workload. Requires the import permission for the entity (for example `account:import`, `user:import`, or `area:add` for Area). Track progress with /import/get or /import/list. See [Importing Data](/docs/info/import#file-limits-and-sizing) for sizing guidance and processing behavior.

📄️ Get Import

Retrieve the status and details of a single import by its ID, including success, error, and skipped counts. For failed rows, use /import/errors. Address-resolution failures distinguish invalid supplied coordinates from addresses not found in the lookups used by the import. Use this to poll an import you started with /import/add. Use /import/list instead to browse or find imports when you do not have the ID. Requires the import permission for the entity, scoped to the import owner.

📄️ List Imports

Retrieve a page of imports for the current company, newest first. Pass the previous response cursor to fetch the next page. `size` defaults to 100 (maximum 1,000). Archived imports are excluded unless archived is set. Only imports the caller has the import permission for are returned. Use /import/get instead when you already have an import ID.

📄️ Get Import Errors

Retrieve the error records for an import. Each record contains a pre-signed URL to download the raw error data for that row. When a row has no coordinate columns and its address cannot be resolved, the stored row error names the address lookups that ran and explains that a new address can take up to about a quarter to appear in First American address data; adding latitude and longitude and re-importing with the same settings places the pin at those coordinates. Rows with missing or invalid values in supplied coordinate columns instead identify those columns. Use this when /import/get or /import/list reports errors for an import. Requires the import permission for the entity, scoped to the import owner.

📄️ Cleanup Import

Rolls back and removes all records that were created by the specified import. Use this to undo an import that contained incorrect data. The rollback runs asynchronously after the request returns. Requires the import permission for the entity, scoped to the import owner.