The first limit staged rows plus a suggested mapping

GET /imports/{jobId}/preview

The first limit staged rows (default 50) plus a suggested mapping, matched from the file's headers against the target's field names and aliases.

The suggestion is a starting point the caller is expected to correct — it is never applied on its own.

Access

Requires imports:read.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

AI agent tool

Agents call this as imports_preview_job (Imports: Preview job), in the imports toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/preview?limit=5' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/preview?limit=5", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "job": {
    "id": "imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80",
    "target": "inventory.item",
    "filename": "opening-stock.csv",
    "status": "staged",
    "headers": [
      "SKU",
      "Product name",
      "Qty"
    ],
    "progress": {
      "rows": 4,
      "applied": 0,
      "failed": 0,
      "skipped": 0
    },
    "createdAt": "2026-10-20T06:00:00.000Z",
    "updatedAt": "2026-10-20T06:00:00.000Z"
  },
  "rows": [
    {
      "rowNumber": 0,
      "cells": [
        "SKU",
        "Product name",
        "Qty"
      ]
    },
    {
      "rowNumber": 1,
      "cells": [
        "MUG-SPECKLE",
        "Speckled stoneware mug",
        "120"
      ]
    },
    {
      "rowNumber": 2,
      "cells": [
        "BOWL-SALT-L",
        "Salt-glaze serving bowl, large",
        "40"
      ]
    },
    {
      "rowNumber": 3,
      "cells": [
        "PLATE-SIDE",
        "Side plate",
        "12.5"
      ]
    }
  ],
  "suggested": {
    "hasHeaderRow": true,
    "columns": [
      {
        "column": 0,
        "field": "sku"
      },
      {
        "column": 1,
        "field": "name"
      },
      {
        "column": 2,
        "field": "quantity"
      }
    ]
  },
  "candidates": [
    {
      "target": "inventory.item",
      "matched": 3,
      "requiredMissing": []
    },
    {
      "target": "inventory.adjustment",
      "matched": 2,
      "requiredMissing": [
        "reason"
      ]
    },
    {
      "target": "purchasing.receipt",
      "matched": 2,
      "requiredMissing": [
        "poId"
      ]
    },
    {
      "target": "fulfillment.order",
      "matched": 2,
      "requiredMissing": [
        "reference"
      ]
    },
    {
      "target": "catalog.composite",
      "matched": 2,
      "requiredMissing": [
        "componentSku"
      ]
    },
    {
      "target": "catalog.product",
      "matched": 2,
      "requiredMissing": [
        "productKey"
      ]
    },
    {
      "target": "catalog.price",
      "matched": 1,
      "requiredMissing": [
        "catalogId"
      ]
    },
    {
      "target": "inventory.location",
      "matched": 0,
      "requiredMissing": [
        "name"
      ]
    },
    {
      "target": "crm.company",
      "matched": 0,
      "requiredMissing": [
        "name"
      ]
    },
    {
      "target": "crm.person",
      "matched": 0,
      "requiredMissing": [
        "email"
      ]
    },
    {
      "target": "fulfillment.ship",
      "matched": 0,
      "requiredMissing": [
        "orderId",
        "shipmentId"
      ]
    },
    {
      "target": "purchasing.po",
      "matched": 2,
      "requiredMissing": [
        "reference",
        "supplier",
        "unitCostCents"
      ]
    },
    {
      "target": "fulfillment.pick",
      "matched": 2,
      "requiredMissing": [
        "orderId",
        "shipmentId",
        "lineId"
      ]
    },
    {
      "target": "fulfillment.refund",
      "matched": 2,
      "requiredMissing": [
        "reference",
        "orderId",
        "amountCents",
        "lineId"
      ]
    },
    {
      "target": "purchasing.supplier-payment",
      "matched": 0,
      "requiredMissing": [
        "reference",
        "currency",
        "method",
        "poId",
        "amountCents"
      ]
    },
    {
      "target": "fulfillment.payout",
      "matched": 0,
      "requiredMissing": [
        "provider",
        "providerPayoutId",
        "currency",
        "netCents",
        "issuedAt",
        "kind",
        "amountCents"
      ]
    },
    {
      "target": "fulfillment.historical-order",
      "matched": 2,
      "requiredMissing": [
        "externalNumber",
        "placedAt",
        "currency",
        "outcome",
        "totalCents",
        "paidCents",
        "name",
        "unitPriceCents"
      ]
    }
  ]
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: import-export.openapi.json. Base URL https://import.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`ImportJobNotFound` jobId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Try again shortly.

How refusals work everywhere: Errors.

Used in

Bulk import from a spreadsheet, step 3: Preview it