Skip to main content
GET
List data migrations
This endpoint returns the migrations of your platform, newest first, whoever started them and wherever: the API, the AI connector or the Data Migration page of your administration panel. Each one is a summary: Get data migration returns its results, warnings and the items that did not start. Use it to find a migration whose ID you lost, or to see whether one is still queued or running before you start another. Migrations made before this endpoint existed are not listed. Their rows are in List data migration history, with run_id set to null.
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.

Query Parameters

integer
default:"15"
Migrations per page, from 1 to 100.
integer
default:"1"
The page number.
Unknown fields are refused.

Response

object[]
The migrations of this page, newest first. Each one has the fields of Get data migration without results, warnings and not_started: id, status, channel, error, initiated_by, source_user, destination_user, counts, succeeded, failed, created_at, started_at and finished_at
integer
The current page
integer
The last page
integer
Migrations per page
integer
The number of migrations
integer | null
The position of the first migration of this page
integer | null
The position of the last migration of this page
string
The first page
string
The last page
string | null
The next page, or null on the last page
string | null
The previous page, or null on the first page
string
The endpoint’s URL, without the query
Links to the pages: url, label and active

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.

Example