Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Exports

Create Export

Create a new data export

post/exports

Request body

collectionsExportCollection[] required

The collections of objects to export.

parametersobject nullable

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

format'csv' | 'json'

An enumeration.

columnsstring[] nullable

If provided, the export will only include these columns.

Example request

{
  "collections": [
    "subscribers"
  ],
  "parameters": {
    "status": "active"
  },
  "columns": [
    "id",
    "email"
  ]
}

Response

Created

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.

collectionsExportCollection[] required

The collections of objects to export.

parametersobject nullable

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

format'csv' | 'json'

An enumeration.

columnsstring[] nullable

If provided, the export will only include these columns.

urlstring nullable

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

completion_datestring date-time nullable

The date and time the export completed.

status'error' | 'in_progress' | 'not_started' | 'ready' required

Represents the status of an export.

No action is required to move from one state or another; Buttondown internally handles the transitions, and exposing the status is for observability purposes only.

Example response

{
  "collections": [
    "subscribers"
  ],
  "parameters": {
    "status": "active"
  },
  "columns": [
    "id",
    "email"
  ]
}