Skip to main content
POST
Sample records before importing them

Authorizations

X-API-Key
string
header
required

Body

application/json

What to sample.

integration_id
string<uuid>
required

The connected integration to sample.

record_type
string
required

Which object to sample.

Required string length: 1 - 255

Response

Successful Response

A sample of the records an import would bring in, and the fields inside them.

Nothing is created here: no table, no column, no row. Review it, then POST to the create endpoint to build the table.

fields
SourceFieldSchema · object[]
required

Sampled and declared fields.

identity_field
string | null
required

The recommended key of the record's ids to match rows on across refreshes: one the tool sets itself where it says which those are. Null means the provider returned nothing usable, and the import cannot proceed.

identity_field_choices
string[]
required

Every id key rows could be matched on: present on all sampled records, and no two records share a value.

identity_field_options
IdentityFieldOptionSchema · object[]
required

Every id key the sample carries, usable or not, with how many records have it, whether values repeat, and whether people can edit it.

integration_id
string<uuid>
required
integration_type
string
required
record_type
string
required
sample_records
Sample Records · object[]
required

The sampled records themselves.

suggested_display_paths
string[]
required

Fields the create step would give their own column.

supports_incremental
boolean
required

Whether the provider can return only records changed since a given time. When false every refresh re-lists everything.