CRM migration API
14 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/tenant/migrations/ |
List Migrations Query: status, limit, offset. |
POST |
/api/tenant/migrations/ |
Create Migration Accepts a JSON body. |
GET |
/api/tenant/migrations/history/all |
Unified Import History Query: limit, offset. |
GET |
/api/tenant/migrations/{job_id} |
Get Migration |
POST |
/api/tenant/migrations/{job_id}/auto-map |
Auto Map Fields |
POST |
/api/tenant/migrations/{job_id}/connect |
Connect Source |
PATCH |
/api/tenant/migrations/{job_id}/mappings |
Update Mappings Accepts a JSON body. |
POST |
/api/tenant/migrations/{job_id}/preview |
Preview Migration Query: limit. |
GET |
/api/tenant/migrations/{job_id}/progress |
Migration Progress |
GET |
/api/tenant/migrations/{job_id}/records |
List Migration Records Query: status, limit, offset. |
POST |
/api/tenant/migrations/{job_id}/rollback |
Rollback Migration |
POST |
/api/tenant/migrations/{job_id}/start |
Start Migration Accepts a JSON body. |
POST |
/api/tenant/migrations/{job_id}/upload-csv |
Upload Csv For Migration Accepts a JSON body. |
POST |
/api/tenant/migrations/{job_id}/validate |
Validate Migration |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.