Skip to main content
GET
Get project import status.
Back to the Project API overview Use this endpoint to get the status of a project import. Poll it with the operationId that Start project import returns. The response shows the overall status, the progressPercent, and the state of each layer: pending, staged, activated, skipped, failed, or rolled_back. The request needs the project_io.write scope. After the import finishes, applied shows how many records and tools the import created, updated, and deleted. dependencyValidation lists missing and circular dependencies. Warnings are informational and errors are blocking. A reverted status means the import’s changes were reverted. A successful request does not mean the import succeeded. Check data.status and data.errors.

Authorizations

x-api-key
string
header
required

Project-bound Platform Key supplied in the x-api-key header. The key must include the operation's required scope: project_io.read for export operations or project_io.write for import operations. A pipeline that promotes changes normally requires both scopes.

Path Parameters

projectId
string
required

Project identifier. The project must belong to the authenticated tenant.

Minimum string length: 1
importId
string
required

Identifier returned when the import operation is created.

Minimum string length: 1

Response

Current import operation status.

success
boolean
required

Indicates that the status request was read successfully. The operation itself may still be running or may have failed; inspect data.status and data.errors.

data
object
required

Import operation record and its current validation, dependency, progress, result, warning, and error state.