---
title: "Start Migration Discovery"
method: POST
path: "/integrations/migrations/discovery"
tags: ["Integrations"]
---

# Start Migration Discovery

`POST /integrations/migrations/discovery`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/integrations/migrations/discovery`
- Auth: HTTP bearer

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- StartDiscoveryRequest: 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`.
  - `connection_id` string, required
  - `crm_type` string: Which CRM. The app's default is `hubspot`.

## Response `202`

Successful Response

- ApiResponseConnectionPayload
  - `data` ConnectionPayload, 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".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)