Duplicate board

View as Markdown

Deep-copies the board and returns the copy in full, in the same shape as a board read.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects a nullable object.
namestring or nullOptional4-80 characters

Name for the copy. Defaults to <source name> (copy).

tagstring or nullOptional4-80 characters

Tag for the copy. Omit to inherit the source board’s tag; send null to leave the copy untagged.

Response

Successful Response
idstringformat: "uuid"

Board identifier, used as {board_id} in every nested route

namestring
Board display name
created_byobject
Actor that created the board
created_atdatetime
Creation time, UTC, RFC 3339
updated_byobject
Actor that last changed the board or anything on it
updated_atdatetime
Last change time, UTC, RFC 3339
tabslist of objects
The board's tabs in position order, each with its widgets nested
filterslist of objects
Every filter token declared by this board's widgets, in display order
tagstring or nullOptional
The board's grouping tag, or null when untagged

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error