---
title: "Read a cap table file before importing it"
method: POST
path: "/captable/imports/read"
tags: ["captable"]
---

# Read a cap table file before importing it

`POST /captable/imports/read`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/captable/imports/read`
- Auth: HTTP bearer

Reads a CSV or XLSX (uploaded as content_base64, or an archived file such as a Pulley export): its columns, how many rows, the first five, and which column holds each field, from the mapping saved for the same columns or guessed from the headers. Says if the file was imported before. Nothing is stored.

## Request body

- union
  - object
    - `file_name` string, required
    - `content_base64` string, required
  - object
    - `archive_file_id` string, required

## Response `200`

The result.

- object
  - `file_name` string, required
  - `sha256` string, required
  - `columns` string[], required
  - `rows` integer, required
  - `sample` array[], required
    - string[]
  - `mapping` object, required
  - `mapping_saved` boolean, required
  - `imported_in` string, nullable, required

## Other responses

- `default`: An RFC 9457 problem.

---

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