Skip to content
Optiwork API Docs

Export a board to Optiwork Drive

POST
/boards/{board}/export/drive
curl --request POST \
  --url https://projects.work.optidata.cloud/api/boards/1/export/drive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "format": "csv", "fields": [ "task_title", "list_name", "due_date", "assignees" ], "node": { "id": 12345, "drive_id": 1 } }'

Exports the board (same formats and fields as Export a board) and uploads the resulting file to a folder (node) in Optiwork Drive instead of streaming it back. Requires export permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
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
node
required

Target Optiwork Drive node (folder) descriptor where the file is uploaded.

object
Example
{
  "format": "csv",
  "fields": [
    "task_title",
    "list_name",
    "due_date",
    "assignees"
  ],
  "node": {
    "id": 12345,
    "drive_id": 1
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Upload result with the created Drive file metadata.

Media typeapplication/json

Drive upload result (file metadata as returned by Optiwork Drive).

object
key
additional properties
any
Examplegenerated
{}

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."
    ]
  }
}