Class Board

Hierarchy

BaseBoard
- Board

Properties

`Optional` createdAt

createdAt?: Date

Date and time when the board was created. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` createdBy

createdBy?: UserInfoShort

`Optional` currentUserMembership

currentUserMembership?: BoardMember

description

description: string

Description of the board.

id

id: string

`Optional` lastOpenedAt

lastOpenedAt?: Date

Date and time when the board was last opened by any user. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` lastOpenedBy

lastOpenedBy?: UserInfoLastOpenedBy

`Optional` modifiedAt

modifiedAt?: Date

Date and time when the board was last modified. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` modifiedBy

modifiedBy?: UserInfoShort

name

name: string

Name of the board.

`Optional` owner

owner?: UserInfoShort

`Optional` picture

picture?: Picture

`Optional` policy

policy?: BoardPolicy

`Optional` project

project?: BoardProject

`Optional` team

team?: Team

type

type: string

Type of the object that is returned. In this case, type returns board.

`Optional` viewLink

viewLink?: string

URL to view the board.

Methods

copy

copy(copyBoardChanges: undefined | CopyBoardChanges): Promise<Board>
Creates a copy of an existing board. You can also update the name, description, sharing policy, and permissions policy for the new board in the request body.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 4

Summary
Copy board
Parameters
- copyBoardChanges: undefined | CopyBoardChanges
Returns Promise<Board>
- Defined in highlevel/index.ts:701

createAppCardItem

createAppCardItem(appCardCreateRequest: AppCardCreateRequest): Promise<AppCardItem>
Adds an app card item to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create app card item
Parameters
- appCardCreateRequest: AppCardCreateRequest
Returns Promise<AppCardItem>
- Defined in highlevel/index.ts:438

createCardItem

createCardItem(cardCreateRequest: CardCreateRequest): Promise<CardItem>
Adds a card item to a board
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create card item
Parameters
- cardCreateRequest: CardCreateRequest
Returns Promise<CardItem>
- Defined in highlevel/index.ts:449

createConnector

createConnector(connectorCreationData: ConnectorCreationData): Promise<Connector>
Adds a connector to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create connector
Parameters
- connectorCreationData: ConnectorCreationData
Returns Promise<Connector>
- Defined in highlevel/index.ts:460

createDocumentItem

createDocumentItem(request: DocumentCreateRequest | WidgetCreateWithBufferRequest): Promise<DocumentItem>
Adds a document item to a board.
Required scope
boards:write
Rate limiting
Level 2

This method can be used to create a document item with a new URL or from a document file.

Summary
Create document item
Parameters
- request: DocumentCreateRequest | WidgetCreateWithBufferRequest
  
  If request.data.url is set then the URL will be used to create a document otherwise contents of a request.data.data will be uploaded and used to create a document
Returns Promise<DocumentItem>
Inherited from BaseBoard.createDocumentItem
- Defined in highlevel/Board.ts:172

createDocumentItemUsingFileFromDevice

createDocumentItemUsingFileFromDevice(resource: RequestFile, data: undefined | CreateDocumentItemUsingFileFromDeviceRequestData): Promise<DocumentItem>
Adds a document item to a board by selecting file from device.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create document item using file from device
Parameters
- resource: RequestFile
  
  Select a file to upload. Maximum file size is 6 MB.
- data: undefined | CreateDocumentItemUsingFileFromDeviceRequestData
Returns Promise<DocumentItem>
- Defined in highlevel/index.ts:555

createEmbedItem

createEmbedItem(embedCreateRequest: EmbedCreateRequest): Promise<EmbedItem>
Adds an embed item containing external content to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create embed item
Parameters
- embedCreateRequest: EmbedCreateRequest
Returns Promise<EmbedItem>
- Defined in highlevel/index.ts:471

createFrameItem

createFrameItem(frameCreateRequest: FrameCreateRequest): Promise<FrameItem>
Adds a frame to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create frame
Parameters
- frameCreateRequest: FrameCreateRequest
Returns Promise<FrameItem>
- Defined in highlevel/index.ts:482

createImageItem

createImageItem(request: ImageCreateRequest | WidgetCreateWithBufferRequest): Promise<ImageItem>
Adds an image item to a board.
Required scope
boards:write
Rate limiting
Level 2

This method can be used to create an image item with a new URL or from an image file.

Summary
Create image item
Parameters
- request: ImageCreateRequest | WidgetCreateWithBufferRequest
  
  If request.data.url is set then the URL will be used to create an image otherwise contents of a request.data.data will be uploaded and used to create an image
Returns Promise<ImageItem>
Inherited from BaseBoard.createImageItem
- Defined in highlevel/Board.ts:158

createImageItemUsingLocalFile

createImageItemUsingLocalFile(resource: RequestFile, data: undefined | UploadFileFromDeviceData): Promise<ImageItem>
Adds an image item to a board by specifying a file from device.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create image item using file from device
Parameters
- resource: RequestFile
  
  Select a file to upload. Maximum file size is 6 MB.
- data: undefined | UploadFileFromDeviceData
Returns Promise<ImageItem>
- Defined in highlevel/index.ts:540

createShapeItem

createShapeItem(shapeCreateRequest: ShapeCreateRequest): Promise<ShapeItem>
Adds a shape item to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create shape item
Parameters
- shapeCreateRequest: ShapeCreateRequest
Returns Promise<ShapeItem>
- Defined in highlevel/index.ts:493

createStickyNoteItem

createStickyNoteItem(stickyNoteCreateRequest: StickyNoteCreateRequest): Promise<StickyNoteItem>
Adds a sticky note item to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create sticky note item
Parameters
- stickyNoteCreateRequest: StickyNoteCreateRequest
Returns Promise<StickyNoteItem>
- Defined in highlevel/index.ts:504

createTag

createTag(tagCreateRequest: TagCreateRequest): Promise<Tag>
Creates a tag on a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Create tag
Parameters
- tagCreateRequest: TagCreateRequest
Returns Promise<Tag>
- Defined in highlevel/index.ts:517

createTextItem

createTextItem(textCreateRequest: TextCreateRequest): Promise<TextItem>
Adds a text item to a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Create text item
Parameters
- textCreateRequest: TextCreateRequest
Returns Promise<TextItem>
- Defined in highlevel/index.ts:528

delete

delete(): Promise<void>
Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

Summary
Delete board

Returns Promise<void>
- Defined in highlevel/index.ts:729

getAllConnectors

getAllConnectors(): AsyncGenerator<Connector, void, unknown>
Retrieves all connectors for a specific board.
Required scope
boards:read
Rate limiting
Level 2
Returns an iterator which will automatically paginate and fetch all available tags

Returns AsyncGenerator<Connector, void, unknown>
Inherited from BaseBoard.getAllConnectors
- Defined in highlevel/Board.ts:117

getAllItems

getAllItems(query?: Omit<undefined | {
    cursor?: string;
    limit?: string;
    type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "app_card" | "sticky_note" | "card" | "preview";
}, "cursor">): AsyncGenerator<WidgetItem, void, unknown>
Retrieves a list of items for a specific board. You can retrieve all items on the board, or a list of specific types of items by specifying URL query parameter values.
Required scope
boards:read
Rate limiting
Level 2
Returns an iterator which will automatically paginate and fetch all available items

Summary
Get items on board
Parameters
- Optional query: Omit<undefined | {
      cursor?: string;
      limit?: string;
      type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "app_card" | "sticky_note" | "card" | "preview";
  }, "cursor">
Returns AsyncGenerator<WidgetItem, void, unknown>
Inherited from BaseBoard.getAllItems
- Defined in highlevel/Board.ts:43

getAllMembers

getAllMembers(): AsyncGenerator<BoardMember, void, unknown>
Get all members on the board.
Required scope
boards:read
Rate limiting
Level 1

Returns an iterator which will automatically paginate and fetch all available members

Summary
Get all board members

Returns AsyncGenerator<BoardMember, void, unknown>
Inherited from BaseBoard.getAllMembers
- Defined in highlevel/Board.ts:71

getAllTags

getAllTags(): AsyncGenerator<Tag, void, unknown>
Retrieves all the tags from the specified board.
Required scope
boards:read
Rate limiting
Level 1

Returns an iterator which will automatically paginate and fetch all available tags

Summary
Get tags from board

Returns AsyncGenerator<Tag, void, unknown>
Inherited from BaseBoard.getAllTags
- Defined in highlevel/Board.ts:95

getAppCardItem

getAppCardItem(itemId: string): Promise<AppCardItem>
Retrieves information for a specific app card item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get app card item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<AppCardItem>
- Defined in highlevel/index.ts:569

getCardItem

getCardItem(itemId: string): Promise<CardItem>
Retrieves information for a specific card item on a board
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get card item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<CardItem>
- Defined in highlevel/index.ts:580

getConnector

getConnector(connectorId: string): Promise<Connector>
Retrieves information for a specific connector on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get specific connector
Parameters
- connectorId: string
  
  Unique identifier (ID) of the connector that you want to retrieve.
Returns Promise<Connector>
- Defined in highlevel/index.ts:591

getDocumentItem

getDocumentItem(itemId: string): Promise<DocumentItem>
Retrieves information for a specific document item on a board
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get document item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<DocumentItem>
- Defined in highlevel/index.ts:602

getEmbedItem

getEmbedItem(itemId: string): Promise<EmbedItem>
Retrieves information for a specific embed item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get embed item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<EmbedItem>
- Defined in highlevel/index.ts:613

getFrameItem

getFrameItem(itemId: string): Promise<FrameItem>
Retrieves information for a specific frame on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get frame
Parameters
- itemId: string
  
  Unique identifier (ID) of the frame that you want to retrieve.
Returns Promise<FrameItem>
- Defined in highlevel/index.ts:624

getImageItem

getImageItem(itemId: string): Promise<ImageItem>
Retrieves information for a specific image item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get image item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<ImageItem>
- Defined in highlevel/index.ts:635

getItem

getItem(itemId: string): Promise<WidgetItem>
Retrieves information for a specific item on a board.
Required scope
boards:read
Rate limiting
Level 1

Summary
Get specific item on board
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<WidgetItem>
Inherited from BaseBoard.getItem
- Defined in highlevel/Board.ts:143

getMember

getMember(boardMemberId: string): Promise<BoardMember>
Retrieves information for a board member.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get specific board member
Parameters
- boardMemberId: string
  
  Unique identifier (ID) of the board member whose role you want to retrieve.
Returns Promise<BoardMember>
- Defined in highlevel/index.ts:657

getShapeItem

getShapeItem(itemId: string): Promise<ShapeItem>
Retrieves information for a specific shape item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get shape item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<ShapeItem>
- Defined in highlevel/index.ts:646

getStickyNoteItem

getStickyNoteItem(itemId: string): Promise<StickyNoteItem>
Retrieves information for a specific sticky note item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get sticky note item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<StickyNoteItem>
- Defined in highlevel/index.ts:668

getTag

getTag(tagId: string): Promise<Tag>
Retrieves information for a specific tag.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get tag
Parameters
- tagId: string
  
  Unique identifier (ID) of the tag that you want to retrieve.
Returns Promise<Tag>
- Defined in highlevel/index.ts:679

getTextItem

getTextItem(itemId: string): Promise<TextItem>
Retrieves information for a specific text item on a board.
Required scope
boards:read
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Get text item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to retrieve.
Returns Promise<TextItem>
- Defined in highlevel/index.ts:690

removeMember

removeMember(boardMemberId: string): Promise<void>
Removes a board member from a board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Remove board member
Parameters
- boardMemberId: string
  
  Unique identifier (ID) of the board member whose role you want to delete.
Returns Promise<void>
- Defined in highlevel/index.ts:738

removeTag

removeTag(itemId: string, tagId: string): Promise<void>
Removes the specified tag from the specified item. The tag still exists on the board.
Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Attach tag to item, Update tag, Delete tag.

Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

Summary
Remove tag from item
Parameters
- itemId: string
  
  Unique identifier (ID) of the item that you want to remove the tag from.
- tagId: string
  
  Unique identifier (ID) of the tag that you want to remove from the item.
Returns Promise<void>
- Defined in highlevel/index.ts:748

share(boardMembersInvite: BoardMembersInvite): Promise<void>
Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

Summary
Share board
Parameters
- boardMembersInvite: BoardMembersInvite
Returns Promise<void>
- Defined in highlevel/index.ts:712

update

update(boardChanges: BoardChanges): Promise<void>
Updates a specific board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Update board
Parameters
- boardChanges: BoardChanges
Returns Promise<void>
- Defined in highlevel/index.ts:721

Class Board

Hierarchy

Index

Properties

Methods

Properties

Optional createdAt

Optional createdBy

Optional currentUserMembership

description

id

Optional lastOpenedAt

Optional lastOpenedBy

Optional modifiedAt

Optional modifiedBy

name

Optional owner

Optional picture

Optional policy

Optional project

Optional team

type

Optional viewLink

Methods

copy

Required scope

Rate limiting

Summary

Parameters

copyBoardChanges: undefined | CopyBoardChanges

Returns Promise<Board>

createAppCardItem

Required scope

Rate limiting

Summary

Parameters

appCardCreateRequest: AppCardCreateRequest

Returns Promise<AppCardItem>

createCardItem

Required scope

Rate limiting

Summary

Parameters

cardCreateRequest: CardCreateRequest

Returns Promise<CardItem>

createConnector

Required scope

Rate limiting

Summary

Parameters

connectorCreationData: ConnectorCreationData

Returns Promise<Connector>

createDocumentItem

Required scope

Rate limiting

Summary

Parameters

request: DocumentCreateRequest | WidgetCreateWithBufferRequest

Returns Promise<DocumentItem>

createDocumentItemUsingFileFromDevice

Required scope

Rate limiting

Summary

Parameters

resource: RequestFile

data: undefined | CreateDocumentItemUsingFileFromDeviceRequestData

Returns Promise<DocumentItem>

createEmbedItem

Required scope

Rate limiting

Summary

Parameters

embedCreateRequest: EmbedCreateRequest

Returns Promise<EmbedItem>

createFrameItem

Required scope

Rate limiting

Summary

Parameters

frameCreateRequest: FrameCreateRequest

`Optional` createdAt

`Optional` createdBy

`Optional` currentUserMembership

`Optional` lastOpenedAt

`Optional` lastOpenedBy

`Optional` modifiedAt

`Optional` modifiedBy

`Optional` owner

`Optional` picture

`Optional` policy

`Optional` project

`Optional` team

`Optional` viewLink

`Optional` query: Omit<undefined | {
cursor?: string;
limit?: string;
type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "app_card" | "sticky_note" | "card" | "preview";
}, "cursor">