Skip to content

Preview Import File

POST
/imports/{import_id}/preview

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

Authorizations

Parameters

Path Parameters

import_id
required

Id returned by the upload.

string

Id returned by the upload.

Query Parameters

page
integer
default: 1 >= 1
limit
integer
default: 10 >= 1 <= 100

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

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.

object
key
additional properties
string

Responses

200

Successful Response

object
data
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.

object
rows
Array<object>
object
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string