• 🚧 Only available for Enterprise plans
• Required scope: boards:read for both operations (not boards:write — the export only reads board data)
• The exported file is always CSV

The export workflow:

1. Call create_board_export with the board_id
2. If the response is ExportFile, download download_url immediately
3. If the response is ExportAsyncJob, poll export_job_status with its job_id until the job reaches a terminal state

Queries

Get export job status

• 🚧 Only available for Enterprise plans — other accounts receive a FORBIDDEN_EXCEPTION error
• Required scope: boards:read
• Returns the current state of an async board export as ExportJobStatusInfo, or null
• Use it to poll a job_id returned by create_board_export

query {
  export_job_status(job_id: "a1b2c3d4-0000-0000-0000-000000000000") {
    status
    download_url
    failure_reason
    failure_message
  }
}

import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `query ($job: ID!) { export_job_status (job_id: $job) { status download_url failure_reason failure_message }}`
const variables = {
  job: "a1b2c3d4-0000-0000-0000-000000000000"
}
const response = await mondayApiClient.request(query, variables);

Arguments

Polling

Poll until status is one of the terminal values — COMPLETED, FAILED, or CANCELLED:

• COMPLETED — read download_url. It can still be null if you poll after the URL has expired, so check before using it.
• FAILED — read failure_reason (and failure_message when present).
• RUNNING — wait and poll again.

Back off between polls rather than polling in a tight loop; every call counts against your rate limits. Large exports can take minutes, so set a timeout in your own client rather than polling indefinitely.

Mutations

Required scope: boards:read (not boards:write — this mutation only reads board data)

Create board export

• 🚧 Only available for Enterprise plans
• Exports a board to a CSV file and returns ExportResult
• The exported file is always CSV

mutation {
  create_board_export(
    board_id: 1234567890
    export_options: { include_subitems: true, header_row: COLUMN_ID, columns_order: ["name", "status", "date4"] }
    time_zone: "America/New_York"
  ) {
    ... on ExportFile {
      download_url
      expires_at
    }
    ... on ExportAsyncJob {
      job_id
    }
  }
}

import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `mutation ($board: ID!) { create_board_export (board_id: $board) { ... on ExportFile { download_url expires_at } ... on ExportAsyncJob { job_id }}}`
const variables = {
  board: 1234567890
}
const response = await mondayApiClient.request(query, variables);

const result = response.create_board_export;
if (result.download_url) {
  // Finished synchronously — download it now.
} else {
  // Still running — poll export_job_status with result.job_id.
}

Arguments

Returns

ExportResult — a union of:

Use __typename if you would rather branch explicitly than infer the branch from which fields came back:

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

Errors

The result has no error branch. Failures reach you one of two ways:

• As a GraphQL error, if the request is rejected before the export starts — for example an invalid board_id, missing permissions, or an unsupported combination of export options. Accounts that are not on an Enterprise plan are rejected here with the FORBIDDEN_EXCEPTION error code.
• As a FAILED status on export_job_status, if an async export fails after starting. Read ExportFailureReason to find out why.

Download URLs

download_url is a presigned URL and expires. Treat it as a secret — anyone who has it can download the file until it expires. It cannot be refreshed: once it expires, call create_board_export again to produce a new file.

See also

• Board Export overview - sync vs. async at a glance
• Board export other types - input objects, result types, and enums