ExportAsyncJob

Returned by create_board_export. Poll export_job_status with the job's job_id until the status is COMPLETED, FAILED, or CANCELLED.

ExportFile

A completed board export, ready to download. Returned as one branch of ExportResult when the export finished within the synchronous window.

CreateBoardExportOptionsInput

Optional export configuration, passed to create_board_export. Every field is optional; omitting the whole object exports the board with the defaults below.

ExportResult

A union returned by create_board_export. It is either a finished export you can download immediately, or a reference to a job that is still running.

union ExportResult = ExportAsyncJob | ExportFile

The server decides which member to return based on board size and current load. Which branch you get is not part of the contract and can change without notice, so your query must handle both. Select both members with inline fragments:

mutation {
  create_board_export(board_id: 1234567890) {
    ... on ExportFile {
      download_url
      expires_at
    }
    ... on ExportAsyncJob {
      job_id
    }
  }
}

There is no error member. Problems surface either as a GraphQL error (if the request is rejected before the export starts) or as a FAILED status on export_job_status (if it fails after starting).

HeaderFormat

Format of the header row in an exported file. Used by CreateBoardExportOptionsInput.header_row.

ConnectedItemColumnFormat

Output format for connected items (Connect boards) column values. Used by CreateBoardExportOptionsInput.connected_item_column_format.

PeopleColumnFormat

Output format for people column values. Used by CreateBoardExportOptionsInput.people_column_format.

Omit the option entirely to keep the raw ID form, which is what you want if the values need to be resolved back to specific users or teams.

ExportJobStatusInfo

The current state of an async board export job. Returned by export_job_status.

Note that a COMPLETED job can still return a null download_url if you poll after the URL has expired, so check for null before using it.

ExportJobStatus

Lifecycle status of an async board export job. Used by ExportJobStatusInfo.status.

Treat any unrecognized value as terminal so a future addition cannot leave your client polling forever.

ExportFailureReason

Structured reason an async board export job failed. Used by ExportJobStatusInfo.failure_reason.

See also

• Board Export overview - sync vs. async at a glance
• Board Export API reference - create_board_export and export_job_status