Sign in
Imports

Retrieve Import

Retrieve a specific import by its ID

get/imports/{id}

Path parameters

idstring required

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

type'subscriber_import' required

An enumeration.

status'failed' | 'in_progress' | 'not_started' | 'succeeded' | 'validating' required

An enumeration.

source'bare' | 'beehiiv' | 'buttondown' | 'custom' | 'flodesk' | 'ghost' | 'google' | 'mailchimp' | 'mailerlite' | 'memberful' | 'pencilbooth' | 'sender_dot_net' | 'sendy' | 'shopify' | 'sparkloop' | 'squarespace' | 'standard' | 'substack' | 'tinyletter' required

An enumeration.

labelstring nullable

An optional label for the import.

metadataobject

Metadata about the import, such as detected column mappings.

Changes

No recorded changes to this endpoint across all 11 revisions of this API.