Skip to main content
GET
List data migration flows
This endpoint returns the automation flows of one user, for flow_ids in Preview data migration and Start data migration. It is the Automate Flows list of the Data Migration page of your administration panel, once a source user is selected. A user without an automation workspace has no flows: the list is empty and complete is true.
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.

Long lists

The list stops at 1000 flows, or after 20 seconds. complete is then false, and reason says why:
  • max_pages: the user has more than 1000 flows;
  • budget: the 20 seconds ran out;
  • stalled or failed: the workspace could not be read to the end. Try again later.
A flow does not have to be in this list to be migrated: flow_ids accepts any flow of the source user’s workspace, and each one is checked when you preview or start the migration. Flows behind the assistants’ webhooks are copied with their assistants (see automate_flows in Get data migration items), so you do not need to list them in flow_ids.

Path Parameters

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

Response

object
The user’s flows

Rate limit

The data migration endpoints count toward the limit of 60 requests per minute for each account that the administration endpoints share. Listing flows also has its own limit: 10 per minute for each account, and 10 per minute for your whole platform, counted together for the API, the AI connector and the Data Migration page. Above a limit it returns 429, and the Retry-After response header tells you how many seconds to wait.

Example