Miro tools
The 12 Miro operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List boardsGETLists the boards the connected user can open, with id, name, description, viewLink, owner, team and dates. Pagination by offset: the response has total, offset and size, and the list ends when offset plus size reaches total. Boards created a few seconds ago may be missing from a text search, but not from a search by team_id.
- Get boardGETReturns a board: name, description, viewLink, owner, team, sharing policy and dates.
- Create boardPOSTCreates a board in the team of the connection and returns it with its id and viewLink. On the free plan a team can have only 3 editable boards.
- Update boardPATCHUpdates the name, description or sharing of a board and returns it. Fields left out keep their value.
- List board membersGETLists the members of a board with id, name and role. The id is the assigneeId that Create card and Update card ask for. Pagination by offset: the list ends when offset plus size reaches total.
- List itemsGETLists the items of a board, such as sticky notes, cards, text, shapes and frames, with id, type, data, position, geometry and parent. An item inside a frame has the id of the frame in parent.id. The response has cursor: pass it as cursor to read the next page; the list ends when cursor is missing.
- Get itemGETReturns one item of a board, of any type, with its data, style, position, geometry and parent.
- Create sticky notePOSTAdds a sticky note to a board and returns it with its id. Without position it goes to the center of the board; inside a frame (parent.id), the position counts from the top-left corner of the frame.
- Update sticky notePATCHUpdates the text, shape, color, position, size or frame of a sticky note and returns it. Fields left out keep their value.
- Create cardPOSTAdds a card, the task item of Miro, to a board and returns it with its id. Without position it goes to the center of the board; inside a frame (parent.id), the position counts from the top-left corner of the frame.
- Update cardPATCHUpdates the title, description, due date, assignee, color, position, size or frame of a card and returns it. Fields left out keep their value.
- Delete itemDELETEDeletes an item of any type from a board, such as a sticky note, card or frame.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
