Skip to main content
GET
Get data migration items
This endpoint returns what can be migrated from one user: their assistants, phone numbers, knowledgebases, tools, widgets, dashboards and voices. These are the lists of the Data Migration page of your administration panel once a source user is selected. Send their IDs to Preview data migration and Start data migration. Automation flows have their own endpoint, List data migration flows.
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. The owner’s own account can be read only by the owner and by team members with Allow impersonate owner. Any other user, and a user outside your platform, returns 404.

Phone numbers

Each number has an action:
  • grant, for normal numbers: the number is shared. The source user keeps it and keeps paying for it, and only the destination user can use it. blockers lists what stops it from being shared: a WhatsApp sender on the number, or a missing or cancelled subscription.
  • transfer, for SIP and Caller ID numbers: the number changes owner. A WhatsApp sender on the number stops it. notes lists the source user’s assistants that will be unassigned from it.
A number the source user already shares with someone is not listed. A number used by assistants that are not migrated with it cannot be shared: Preview data migration shows it for your selection.

Path Parameters

integer
required
The ID of the source user, from List data migration users.

Response

object
What can be migrated from this user. Names are on one line and at most 100 characters

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