Preview an organization import (legacy route)

POST/api/companies/import/preview
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Preview an organization import (legacy route).

Accepts either the inline JSON body (application/json) or the raw organization package uploaded as a compressed zip (multipart/form-data with a package file field plus a JSON meta field carrying the other import fields, or a bare application/zip body with the meta JSON in the meta query parameter). The zip is unzipped server-side into the same { source: { type: "inline", ... } } bundle the JSON body carries.

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.

Request body

application/json · required

sourceobjectRequired
includeobjectOptional
include.companybooleanOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
targetobjectRequired
agentsstring | array<string>Optional
collisionStrategystringOptionalone 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.
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.

Organizations