Buttondown logo

IntroductionStatusesCollectionsFormats

Routes

Creating an exportRetrieving an exportListing exports

Buttondown logo

Introduction

Some software applications may want programmatic access to their newsletter exports. This assists with a few niche use cases, such as regular backups or data ingestion (into a data warehouse), or post-publishing processes that hinge on email events.

In general, you probably won't need to use this endpoint unless you absolutely need to use this endpoint.

To browse the contents of a given export collection, refer to the Data exports section of the documentation.

{
    "collections": [
        "subscribers"
    ],
    "parameters": null,
    "format": "csv",
    "columns": null,
    "id": "exp_29fxqcmrkp969vzttksexvmvr8",
    "creation_date": "2019-08-24T14:15:22",
    "url": "https://s3.amazonaws.com/buttondown-exports/basic-export.csv",
    "completion_date": "2019-08-24T15:15:22",
    "status": "ready"
}

Fields

collections

Type
array
Description

The collections of objects to export.

parameters

Type
object
Description

Parameters to pass to the exporter. These are specific to the collection and format, and constrain the export.

format

Type
ExportFormat
Description

The format of the export files.

columns

Type
array
Description

If provided, the export will only include these columns.

id

Type
string
Description

A unique TypeID associated with the object.

creation_date

Type
string
Description

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

url

Type
string
Description

The URL of the export file. This is only available after the export has completed.

completion_date

Type
string
Description

The date and time the export completed.

status

Type
ExportStatus
Description

The status of the export.