Skip to content

Start Migration Discovery

POST
/integrations/migrations/discovery

Look at what is in the CRM. WRITES NOTHING to graph8.

Counts records, reads the field and pipeline shape, and proposes mappings. Poll GET /integrations/migrations/{migration_id} for the result, then accept it with /confirm.

Org admin, matching the app.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Look at what is in the CRM. Reads the CRM, writes nothing to graph8.

Discovery is the first half of a migration: it counts records, reads the field and pipeline shape, and proposes mappings. Nothing is imported until confirm-and-start.

object
connection_id
required
string
crm_type

Which CRM. The app’s default is hubspot.

string
default: hubspot

Responses

202

Successful Response

object
data
required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string