Skip to main content
GET
Get data migration
This endpoint returns one migration of your platform, with its progress and its results. A migration started with Start data migration runs in the background: poll this endpoint until its status is no longer queued or running. Migrations started from the Data Migration page of your administration panel or through the AI connector are here too.
This endpoint is available to the account owner (with an active plan) and to team members with Platform Admin. Other users receive a 403 Forbidden error. Every administrator sees all the migrations of your platform, whoever started them. A migration of another platform returns 404.

Statuses

A migration that fails when it starts, for example because the selection changed while it was queued, copies nothing. Start a new migration for the items in not_started, or for those that failed.

Undoing what it copied

Each result has log_ids: the rows that List data migration history shows for that item, the item itself and what came with it, such as an assistant’s knowledgebase and tools. Roll back data migration undoes one row at a time. You can also list the rows of a migration with run_id.

Path Parameters

integer
required
The ID of the migration, from Start data migration or List data migrations.

Response

object
The migration

Rate limit

The data migration endpoints count toward the limit of 60 requests per minute for each account that the administration endpoints share. Above it they return 429, and the Retry-After response header tells you how many seconds to wait. Polling every few seconds stays well within it.

Example