---
title: "Preview Import"
method: POST
path: "/api/v1/import/preview"
tags: ["import", "import"]
---

# Preview Import

`POST /api/v1/import/preview`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/import/preview`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

## Response `200`

Successful Response

- ImportPreviewResponse
  - `entity_type` string, required
  - `total_rows` integer, required
  - `ok_count` integer, required
  - `skip_count` integer, required
  - `error_count` integer, required
  - `rows` PreviewRow[], required
    - `row_number` integer, required
    - `status` string
    - `reason` string, nullable
    - `fields` object
    - `client_is_new` boolean
  - `new_clients` string[]

## Other responses

- `422`: Validation Error

---

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