---
title: "Preview Import File"
method: POST
path: "/imports/{import_id}/preview"
tags: ["Imports"]
---

# Preview Import File

`POST /imports/{import_id}/preview`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/imports/{import_id}/preview`
- Auth: HTTP bearer

See how the file will be read, with a mapping applied. Writes nothing.

## Path parameters

- `import_id` string, required: Id returned by the upload.

## Query parameters

- `page` integer
- `limit` integer

## Headers

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

## Request body

- object: Source column -> graph8 field, the same mapping you intend to import with. Send it HERE: an unmapped column the importer cannot recognise is dropped SILENTLY, and this is the only way to see that before writing to a customer's CRM.

## Response `200`

Successful Response

- ApiResponseDataFilePreviewResponse
  - `data` DataFilePreviewResponse, required: A page of rows as they will be read, with the mapping applied. Rows are open dicts: they are the customer's own columns, so there is no schema to pin.
    - `rows` object[]
    - `total` integer
  - `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/2e7cfa0ca921?raw)