Reference
Imports
Create an import job, dry-run it, then apply that same job.
An import matches rows from a file to records the firm already has. Apply uses the job you already validated. This API does not offer apply without that step.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/x/imports | Jobs for a projectId |
| GET | /api/v1/x/imports/{id} | One job |
| POST | /api/v1/x/imports | Create a job |
| POST | /api/v1/x/imports/{id}/dry-run | Validate. Nothing is written to records |
| POST | /api/v1/x/imports/{id}/apply | Confirm that job and process it |
Every call needs admin.import.manage.
The list requires projectId. cursor and limit page it.
Create needs projectId, sourceFileDocumentId, targetEntityType, and conflictStrategy. targetEntityType is a catalog key such as Company. templateId, strategyOverride, balanceDate (yyyy-MM-dd), and mappingConfig are optional.
Dry-run and apply return no body when they succeed. A missing job is 404, including a job in another firm.