List boards visible to the token.

Offset-paginated. query filters on board name/description, owner accepts e.g. me or a user id, sort e.g. default, alphabetically, last_opened, last_created, last_modified. Set fetch_all to walk all pages (careful on large accounts).

Get full details of one board (name, owner, links, sharing policy).

Create a new board. team_id targets a team; project_id targets a Miro space (projects were renamed to spaces).

Copy an existing board, optionally renaming or moving it to a team.

Rename a board or change its description.

Delete a board permanently. Requires confirm=true.

List connectors on a board (cursor-paginated).

Get one connector (start/end items, captions, style).

Connect two items. caption adds a text label. Caps like end_stroke_cap="arrow" control arrowheads; stroke_style is normal, dotted or dashed.

Update a connector's endpoints, caption or style.

Delete a connector. Requires confirm=true.

Create a doc format item on the board.

content_type is markdown or html. Docs cannot be edited via REST after creation — see replace_doc.

Get a doc format item including its markdown/html content.

Delete a doc format item. Requires confirm=true.

Replace a doc's content — implemented as read + delete + create because REST has no doc update endpoint.

The new doc gets a NEW item id; the old id stops existing. Preserves position, geometry, parent and content type (unless overridden). Requires confirm=true.

Get the board's thumbnail image URL.

Reads the board's picture field — a small rendered preview, not a full-fidelity export. For PDF/SVG use the Enterprise export job tools.

List board export jobs for an organization.

ENTERPRISE PLAN ONLY — requires a Discovery access token.

Start a board export job (up to 1000 boards).

ENTERPRISE PLAN ONLY — requires a Discovery access token. format is SVG (default), HTML, or PDF. Returns the job id; poll get_board_export_job_status then download via get_board_export_job_results (results live for 14 days).

Get the status of a board export job.

ENTERPRISE PLAN ONLY — requires a Discovery access token.

Get the download links of a finished board export job.

ENTERPRISE PLAN ONLY — requires a Discovery access token.

Group items together. item_ids are the items to group.

List all groups on a board (cursor-paginated).

Get one group with the items it contains.

List the items that belong to a group (cursor-paginated).

Replace a group's membership entirely with a new set of items.

A new group id is assigned by Miro on update.

Dissolve a group (items stay on the board). Requires confirm=true.

List items on a board in a compact shape (id, type, x, y, size, parent, text).

type filters to one item type (app_card, card, doc_format, document, embed, frame, image, shape, sticky_note, text). parent_item_id lists children of a frame. Cursor-paginated; fetch_all walks all pages.

Get the full JSON of one item (data, style, position, geometry, parent, timestamps).

Search items by text content (client-side scan of titles/content).

Scans up to max_pages x 50 items. Returns compact matches.

Move an item on the canvas or reparent it into/out of a frame.

Works on any item type. parent_id set to a frame id nests the item; use "none" semantics per Miro docs to detach (send parent omitted and change position instead).

Delete any single item. Requires confirm=true; the item id is logged when confirmed.

List items carrying a given tag (offset-paginated).

Create up to 20 items in one call.

Each entry follows the Miro bulk schema: {"type": "sticky_note", "data": {...}, "style": {...}, "position": {"x":..,"y":..}, "geometry": {...}, "parent": {"id": frame_id}}. Types: app_card, card, document, embed, image (URL), shape, sticky_note, text.

Update many items concurrently (client-side batch; no bulk-update endpoint exists in REST).

Each entry: {"item_id": str, "item_type": str?} plus any of data, style, position, geometry, parent dicts sent verbatim. With item_type the typed endpoint is used (e.g. sticky_notes); without it, the generic position/parent endpoint. Returns per-item ok/error results.

Delete many items concurrently. Requires confirm=true; ids are logged when confirmed.

Create a sticky note. content accepts simple HTML (<p>, <b>, <br/>...). fill_color is a Miro palette name (gray, light_yellow, yellow, orange, light_green, green, dark_green, cyan, light_pink, pink, violet, red, light_blue, blue, dark_blue, black).

Update a sticky note's content, style, position or parent.

Create a shape. shape is one of: rectangle, round_rectangle, circle, triangle, rhombus, parallelogram, trapezoid, pentagon, hexagon, octagon, wedge_round_rectangle_callout, star, flow_chart_predefined_process, cloud, cross, can, right_arrow, left_arrow, left_right_arrow, left_brace, right_brace. Colors are hex strings like #ff0000.

Update a shape's content, style, position or parent.

Create a standalone text item. content accepts simple HTML.

Update a text item's content, style, position or parent.

Create a card. due_date is ISO 8601 (2026-12-31).

Update a card's data, style, position or parent.

Create an app card (widget card linked to an app).

status: disconnected, connected or disabled. fields is a list of field values shown on the card. border_shape: round or square.

Update an app card's data, style, position or parent.

Create a frame. show_content hides/shows children on the canvas. format accepts custom; frame type defaults to freeform.

Update a frame's title, visibility, style, size or position.

Create an embed item from a URL. mode: inline or modal.

Update an embed item's data, position or parent.

Add a document item (PDF, etc.) to the board from a URL.

Upload a document file from the local disk (PDF, DOCX, PPTX, XLSX, CSV; max ~30 MB).

Update a document item (replace its URL, retitle, move).

Upload a local image file to the board (PNG/JPG/SVG, max 6 MB).

This is a real multipart upload — the main gap vs. the hosted Miro connector.

Create an image item from a public URL.

Update an image item (swap URL, retitle, move/resize).

List code widget items. EXPERIMENTAL: uses the /v2-experimental endpoints which may change.

Get one code widget. EXPERIMENTAL.

Create a code widget (syntax-highlighted code block). EXPERIMENTAL.

Update a code widget. EXPERIMENTAL.

List members of a board (offset-paginated). Set fetch_all to walk all pages.

Get one board member (role, type).

Invite users to a board by email (up to 20 per call).

role is one of viewer, commenter, editor, coowner. Grants access — requires confirm=true.

Change a board member's role (viewer, commenter, editor, coowner).

Requires confirm=true.

Remove a member from a board. Requires confirm=true.

List mind map nodes on a board. EXPERIMENTAL — the /v2-experimental API may change.

Get one mind map node. EXPERIMENTAL.

Create a mind map node (text type). EXPERIMENTAL.

With parent_node_id the node becomes a child of that node; without it Miro creates/extends the root structure.

Delete a mind map node. EXPERIMENTAL. Requires confirm=true.

Show the context of the current access token.

Returns the token type, the user the token belongs to, the team it was installed on, and the granted scopes. Useful to verify auth before other calls. Requires no board.

List all tags on a board (cursor-paginated).

Create a tag. fill_color (required by Miro) is a colour name: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue or black.

Get one tag.

Rename a tag or change its color. Note: tag changes via REST are not reflected on the board in realtime — refresh the board to see them.

Delete a tag from the board. Requires confirm=true.

Attach a tag to an item (cards/stickies: max 8 tags). Changes are not reflected in realtime — refresh the board to see them.

Remove a tag from an item. Requires confirm=true.

List the tags attached to an item.