Preview a completed organization import transfer
POST
/api/companies/import/transfers/{transferId}/previewPersonal API keyAgent API keyConsole session
Preview a completed organization import transfer.
Runs the import preview against the assembled spool without consuming the transfer: the ledger run stays open and the parts stay spooled, so the subsequent apply reuses them instead of re-uploading. The JSON body carries the same fields as the multipart preview route's meta field (include, target, collisionStrategy, ...).
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
transferIdstringRequiredThe transfer's id.
Request body
application/json · required
includeobjectOptional
include.companybooleanOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
targetobjectRequired
agentsstring | array<string>Optional
collisionStrategystringOptional
one of: "rename", "skip", "replace"nameOverridesobject<string, string>Optional
selectedFilesarray<string>Optional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409Parts are still missing, an apply is in progress, or the transfer was already appliedThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
410The transfer expired and its spooled parts were deleted
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Errors return {"error": "..."}, often with a code and details. See errors and limits.