BUbuttondown
Imports

Retrieve Import

Changed on

Retrieve a specific import by its ID

get/imports/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/imports/{id}
  • Auth
    API key in header Authorization

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' | 'no_op' | '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

  • a1516578e25fRevision changes
    • warning

      added the new no_op enum value to the response property for the response status

  • 228cc05ba97dRevision changes
    • breaking

      added the pattern ^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|(?:sub_imp)_(?:[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ to the path request parameter id

    • warning

      added the new beehiiv enum value to the response property for the response status

    • warning

      added the new pencilbooth enum value to the response property for the response status

    • info

      added the non-success response with the status