Last updatedDec 16, 2019

Automating Exports

Experimental API

This API is not guaranteed to remain as it is. Breaking changes may be introduced without notification.

Trello Business Class and Enterprise teams are able to export Trello boards by navigating to the Export tab of their team or visiting the following URL: https://trello.com/{teamName}/export.

There, users are able to generate exports of Trello boards. The API used to generate these exports is also available and can be used to generate exports at a regular interval.

This page is intended to guide you through the process of creating and downloading an export via the API.

First, you'll need to create a new export. To do so, you can make a POST request like the following:

1
curl -X POST 'https://trello.com/1/organizations/{organizationNameOrId}/exports?key={key}&token={token}' --data 'attachments=false'

This endpoint accepts an attachments parameter. If set to true then the attachments on the board will be included in the export. The default value is false.

This call will return a JSON object that represents the export:

1
2
3
4
5
6
7
8
9
10
11
{
  "id": "5c8939e421c0c474dba0c566",
  "status": {
    "attempts": 0,
    "finished": false,
    "stage": "Export_queued"
  },
  "startedAt": "2019-03-13T17:12:04.000Z",
  "size": null,
  "exportUrl": null
}

You can see there is a status field in the object.

An export will be ready for download at the point in time the status field's key finished is set to true. You can make a GET request to check on the status of exports via the exports nested resource for the organization:

1
curl https://trello.com/1/organizations/{orgIdOrName}/exports/{exportId}?key={key}&token={token}

And this will return the export object with its most up-to-date status:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
	"id": "5c8939e421c0c474dba0c566",
  "status": {
    "attempts": 1,
    "finished": true,
    "stage": "Export_completed",
    "total": 0,
    "progress": 0
  },
  "startedAt": "2019-03-13T17:12:04.000Z",
  "size": 6518,
  "exportUrl": "/1/organization/5a26a6692f1c42b046a2b178/exports/5c8939e421c0c474dba0c566/download"
}

At the point in time an export is finished and ready for download, as above, a new key exportUrl will be returned on the export object. That URL can then be used to download the export.

Additionally, you can get all of the the exports for an organization via a GET request to /1/organizations/{orgId} with the exports=true parameters:

1
curl https://trello.com/1/organizations/{orgIdOrName}/?exports=true&key={key}&token={token}