Call Imports
POST
/api/v1/call-imports/preview

Inspect an uploaded CSV / Excel file and return its sheets + headers.

Drives the column-mapping UI without forcing the frontend to parse CSV / xlsx itself — keeps client and server in lockstep on quoted fields, encodings, and Excel cell coercion. CSVs return a single synthetic sheet named after the filename; Excel workbooks return one entry per worksheet (in workbook order).

Authorization

AuthorizationBearer <token>

JWT access token. Use: Authorization: Bearer .

In: header

Header Parameters

Authorization?string|null
X-API-Key?string|null
X-EFFICIENTAI-API-KEY?string|null
X-Workspace-Id?string|null

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/call-imports/preview" \  -F file="string"
{  "format": "string",  "sheets": [    {      "name": "string",      "headers": [        "string"      ],      "row_count": 0    }  ]}

Community & contact

  1. Found a bug or have a feature request? Open a GitHub issue.
  2. Join our Discord for faster replies!