Skip to content
Optiwork API Docs

Export a board as a file download

GET
/boards/{board}/export
curl --request GET \
  --url 'https://projects.work.optidata.cloud/api/boards/1/export?format=csv&fields%5B%5D=assignees' \
  --header 'Authorization: Bearer <token>'

Exports the board’s cards to CSV, Excel or JSON and streams the file as a download. Requires export permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

Query Parameters

Section titled “Query Parameters”
format
required
string
Allowed values: csv excel json
fields[]
required
Array<string>
Allowed values: assignees content creation_date due_date pinned_at list_name progress tags task_title time_track

Card fields to include in the export.

Responses

Section titled “Responses”

200

Section titled “200”

The exported file (content type depends on format).

string

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
message

First validation error message.

string
errors

Map of field name → list of error messages.

object
key
additional properties
Array<string>
Example
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}