These docs are for v1.0. Click to read the latest docs for v2.0.

Board Object

The Board object returns information about the available boards in your Miro team.
You can create and get boards, get board invites and board collaborators, and share, update, and delete boards.

type
string
board
id
string
Unique identifier for the object
createdAt
date-time
Date and time when the board was created
modifiedAt
date-time
Date and time when the board was modified
createdBy
Mini User Object
The user who first created the board
modifiedBy
Mini User Object
The user who last modified the board
owner
Mini User Object
The user who owns the board
name
string
Name of the board
description
string
Description of the board
picture
Mini Picture Object
Picture of the board
viewLink
string
The link to view the board in a browser
sharingPolicy
object
sharingPolicy.access
string
The global access level of the board. Can be private (no access except board members), view (board can be viewed by external users), comment (external users can leave comments) or edit (external users can edit the board, not available on Free Team and Dev Team).
sharingPolicy.teamAccess
string
The team access level of the board. Can be private, view, comment or edit.
currentUserConnection
Mini User Connection Object
The connection object of the current user in a context and the board. Can be null if there is no relationship between user and board.

🚧

account field is deprecated, please do not use it.

{  
   "type":"board",
   "id":"o9J_kzlUDmo=",
   "name":"Some Board"
}