Miro

Visão geral

Miro é um quadro branco colaborativo online que permite que equipes realizem brainstorming, desenhem wireframes, planejem fluxos de trabalho e gerenciem projetos visualmente em tempo real. Com a integração Miro no SquadOS, seus agentes podem criar e manipular quadros, adicionar formas, notas adesivas, cartões, conectores, imagens, documentos, mapas mentais e muito mais — tudo programaticamente.

• Site oficial: https://miro.com/
• Documentação na Composio: docs.composio.dev/toolkits/miro

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar autorizar o acesso à sua conta Miro por meio da página de conexão segura da Composio. Nenhuma chave de API manual é necessária.

Campo	Obrigatório	Descrição
Autorização OAuth	Sim	Acesso concedido via fluxo OAuth 2.0 na página de conexão da Composio.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Miro.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso à sua conta Miro via OAuth.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Anexar tag a item

MIRO_ATTACH_TAG_TO_ITEM

Anexa uma tag existente a um item específico em um quadro Miro. Use quando precisar associar uma tag a um item após confirmar os IDs do quadro, do item e da tag. Itens do tipo card e nota adesiva podem ter até 8 tags.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag_id	string	Sim	Identificador único da tag a ser anexada ao item.
item_id	string	Sim	Identificador único do item ao qual a tag será anexada. Itens do tipo card e nota adesiva podem ter até 8 tags.
board_id	string	Sim	Identificador único do quadro que contém o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de app card

MIRO_CREATE_APP_CARD_ITEM

Adiciona um item de app card a um quadro. Use quando precisar inserir um cartão de visualização rica com campos personalizados em um quadro Miro. Retorna o cartão criado; o ID do cartão está em data.id na resposta, não no nível raiz. Escritas em rajada podem disparar HTTP 429; respeite o cabeçalho Retry-After antes de tentar novamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Dados de payload para o app card.
style	object	Não	Opções de estilo para o item de app card.
parent	object	Não	Referência ao frame pai para aninhar o item de app card.
board_id	string	Sim	ID do quadro onde o app card será adicionado.
geometry	object	Não	Dimensões geométricas para o item de app card.
position	object	Não	Posição no quadro para o item de app card.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar quadro

MIRO_CREATE_BOARD

Cria um novo quadro. Use quando precisar configurar um quadro com nome, descrição e políticas específicas. Exemplo: “Criar um novo quadro chamado Plano do Projeto”. Se a cota de quadros do workspace for atingida, retorna HTTP 400; use MIRO_GET_BOARDS para reutilizar um quadro existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do quadro, com comprimento entre 1 e 60 caracteres.
policy	object	Não	Define permissões e políticas de compartilhamento do quadro. Aceita valores de enum específicos; valores inválidos retornam HTTP 400 com código de erro 2.0703. Valores válidos para sharingPolicy: private, view, comment, edit, team_access.
teamId	string	Não	Identificador único (ID) da equipe onde o quadro será criado.
projectId	string	Não	Identificador único (ID) do projeto (espaço) ao qual o quadro pertence.
description	string	Não	Descrição do quadro, com comprimento entre 0 e 300 caracteres.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de card

MIRO_CREATE_CARD_ITEM

Cria um item de card em um quadro Miro. Use quando precisar adicionar cartões de tarefa com títulos, descrições, datas de vencimento e responsáveis.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para o item de card.
style	object	Não	Opções de estilo para o item de card.
parent	object	Não	Referência ao item pai para aninhar o card.
board_id	string	Sim	Identificador único do quadro onde o card será criado.
geometry	object	Não	Dimensões geométricas para o item de card.
position	object	Não	Posição no quadro para o item de card.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar conector

MIRO_CREATE_CONNECTOR

Cria um conector (seta/aresta) que liga dois itens existentes no quadro. Use após criar ou localizar os dois itens de extremidade (formas, cards, notas adesivas) para estabelecer relações visuais em fluxogramas e diagramas. Ambos os itens de início e fim devem ser especificados; conectores não podem ser criados com extremidades soltas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
shape	string	Sim	Formato/estilo da linha do conector. Valores: straight, elbowed, curved.
style	object	Não	Propriedades visuais para a linha e legenda do conector.
endItem	object	Sim	Define o ponto final do conector. Deve especificar snapTo ou position.
board_id	string	Sim	Identificador único do quadro onde o conector será criado.
captions	array	Não	Array de objetos de legenda para exibir texto ao longo do conector.
startItem	object	Sim	Define o ponto inicial do conector. Deve especificar snapTo ou position.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de documento

MIRO_CREATE_DOCUMENT_ITEM

Cria um item de documento em um quadro Miro fornecendo uma URL para o documento. Use quando precisar anexar um documento (PDF, DOC, etc.) a um quadro a partir de uma URL acessível publicamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém a URL do documento e título opcional.
parent	object	Não	Referência ao elemento pai para posicionamento hierárquico.
board_id	string	Sim	Identificador único do quadro onde o documento será criado.
geometry	object	Não	Propriedades geométricas com proporção fixa para o item de documento.
position	object	Não	Informações de posicionamento do item de documento no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de documento a partir de arquivo do dispositivo

MIRO_CREATE_DOCUMENT_ITEM_USING_FILE_FROM_DEVICE

Cria um item de documento em um quadro Miro usando uma URL para o documento. Use quando precisar adicionar um documento (PDF, DOC, etc.) a um quadro a partir de uma URL acessível publicamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados contendo metadados do documento, como título.
parent	object	Não	Informações do frame pai para o item.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item.
geometry	object	Não	Informações geométricas sobre o item.
position	object	Não	Informações de posição do item de documento no quadro.
resource	object	Sim	Arquivo de documento a ser enviado. Tamanho máximo: 6 MB. Formato suportado: PDF.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de embed

MIRO_CREATE_EMBED_ITEM

Cria um item de embed em um quadro Miro fornecendo uma URL para incorporar conteúdo (vídeos do YouTube, sites, etc.). Use quando precisar adicionar conteúdo incorporado de fontes externas a um quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém informações sobre a URL a ser incorporada.
parent	object	Não	Referência ao elemento pai para posicionamento hierárquico.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item.
geometry	object	Não	Informações geométricas sobre o item de embed.
position	object	Não	Informações de posicionamento do item de embed no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de frame

MIRO_CREATE_FRAME_ITEM

Adiciona um item de frame a um quadro Miro. Use frames para agrupar e organizar regiões do diagrama (ex.: swimlanes, seções, slides).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém propriedades específicas do frame, como título e formato. Este campo é obrigatório.
style	object	Não	Opções de estilo para o item de frame.
parent	object	Não	Referência ao item pai para aninhar o frame.
board_id	string	Sim	Identificador único do quadro onde o frame será adicionado.
geometry	object	Não	Dimensões geométricas para o item de frame.
position	object	Não	Posição no quadro para o item de frame.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar frame (descontinuado)

MIRO_CREATE_FRAME_ITEM2

DESCONTINUADO: Use MIRO_CREATE_FRAME_ITEM em vez desta ação. Cria um frame em um quadro Miro. Use quando precisar agrupar e organizar conteúdo em seções ou contêineres.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém dados do item de frame, como título, tipo ou formato.
style	object	Não	Opções de estilo para o item de frame.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o frame.
geometry	object	Não	Dimensões geométricas para o item de frame.
position	object	Não	Posição no quadro para o item de frame.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar grupo

MIRO_CREATE_GROUP

Cria um grupo em um quadro Miro agrupando vários itens. Use quando precisar organizar itens relacionados do quadro (formas, notas adesivas, cards, etc.) em um único grupo lógico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém os dados com os IDs dos itens a serem agrupados.
board_id	string	Sim	Identificador único (ID) do quadro onde o grupo será criado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de imagem a partir de arquivo local

MIRO_CREATE_IMAGE_ITEM_USING_LOCAL_FILE

Cria um item de imagem em um quadro Miro enviando um arquivo de imagem local. Use quando precisar adicionar uma imagem do dispositivo do usuário a um quadro, em vez de referenciar uma URL externa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para o item de imagem.
parent	object	Não	Referência ao item pai para aninhar a imagem.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item de imagem.
geometry	object	Não	Dimensões geométricas para o item de imagem.
position	object	Não	Posição no quadro para o item de imagem.
resource	object	Sim	Arquivo de imagem a ser enviado. Formatos suportados: PNG, JPG, JPEG, GIF, SVG, entre outros.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar itens em lote

MIRO_CREATE_ITEMS_IN_BULK

Cria múltiplos itens em um quadro Miro em uma única requisição. Use quando precisar adicionar de 1 a 20 itens (texto, notas adesivas, formas, cards, frames, etc.) de forma eficiente. Os itens são criados atomicamente em uma única chamada de API.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
items	array	Sim	Lista de itens a criar. Você pode criar de 1 a 20 itens por requisição.
board_id	string	Sim	Identificador único do quadro onde os itens serão criados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar nó de mapa mental (experimental)

MIRO_CREATE_MINDMAP_NODE_EXPERIMENTAL

Cria um nó de mapa mental em um quadro Miro. Use ao construir mapas mentais ou organizar ideias visualmente em estrutura hierárquica. Este é um endpoint experimental.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Dados principais do nó de mapa mental, incluindo a visualização do nó com conteúdo.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o nó de mapa mental.
geometry	object	Não	Geometria para o nó de mapa mental.
position	object	Não	Posição do nó de mapa mental no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de forma (descontinuado)

MIRO_CREATE_SHAPE_ITEM

DESCONTINUADO: Use MIRO_CREATE_SHAPE_ITEM2 em vez desta ação. Cria um item de forma nativa do Miro (nó de diagrama) em um quadro. Use ao construir diagramas, fluxogramas ou diagramas de arquitetura com formas que podem ser conectadas via MIRO_CREATE_CONNECTOR.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Dados principais da forma, incluindo texto de conteúdo e tipo de forma.
style	object	Não	Opções de estilo para o item de forma.
parent	object	Não	Referência ao item pai para aninhar a forma.
board_id	string	Sim	Identificador único do quadro onde a forma será criada.
geometry	object	Não	Dimensões geométricas para o item de forma.
position	object	Não	Posição no quadro para o item de forma.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de forma

MIRO_CREATE_SHAPE_ITEM2

Cria um item de forma em um quadro Miro. Use quando precisar adicionar formas (básicas ou de fluxograma) a um quadro com estilo e posicionamento específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para o item de forma.
style	object	Não	Opções de estilo para o item de forma.
parent	object	Não	Informações do frame pai para o item de forma.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item.
geometry	object	Não	Informações geométricas sobre o item de forma.
position	object	Não	Informações de posição para o item de forma.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de nota adesiva

MIRO_CREATE_STICKY_NOTE_ITEM

Cria um item de nota adesiva em um quadro Miro. Use quando precisar adicionar uma nova nota adesiva com conteúdo, cor, forma e posição personalizáveis.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Contém dados do item de nota adesiva, como conteúdo ou forma.
style	object	Não	Contém informações sobre o estilo do item de nota adesiva, como cor de preenchimento ou alinhamento de texto.
parent	object	Não	Contém informações sobre o frame pai do item.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item.
geometry	object	Não	Contém informações geométricas sobre o item. Você pode definir largura ou altura, mas não ambos ao mesmo tempo.
position	object	Não	Contém informações sobre a posição do item no quadro, como coordenadas x e y e a origem dessas coordenadas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar tag

MIRO_CREATE_TAG

Cria uma nova tag em um quadro Miro. Use quando precisar adicionar uma tag com título e cor específicos para categorizar itens do quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Sim	Texto da tag. Diferencia maiúsculas de minúsculas. Deve ser único dentro do quadro.
boardId	string	Sim	Identificador único (ID) do quadro onde você deseja criar a tag.
fillColor	string	Não	Cor de preenchimento da tag. Opções: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black. Padrão: red.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar item de texto

MIRO_CREATE_TEXT_ITEM

Cria um item de texto em um quadro Miro. Use quando precisar adicionar conteúdo textual a um quadro, como rótulos, notas ou anotações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém dados do item de texto, como o conteúdo.
style	object	Não	Opções de estilo para o item de texto.
parent	object	Não	Referência ao item pai para aninhar o item de texto.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja criar o item.
geometry	object	Não	Dimensões geométricas para o item de texto.
position	object	Não	Posição no quadro para o item de texto.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de app card

MIRO_DELETE_APP_CARD_ITEM

Exclui um item de app card de um quadro. Use quando precisar remover um item de app card criado pelo seu aplicativo após ele não ser mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único do item de app card a ser excluído.
board_id	string	Sim	Identificador único do quadro que contém o item de app card.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de card

MIRO_DELETE_CARD_ITEM

Exclui um item de card de um quadro. Use quando precisar remover um item de card de um quadro Miro após ele não ser mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir conector

MIRO_DELETE_CONNECTOR

Exclui um conector específico de um quadro. Use quando precisar remover um conector (seta/aresta) entre itens do quadro após confirmar os IDs do quadro e do conector.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o conector.
connector_id	string	Sim	Identificador único (ID) do conector que você deseja excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de documento

MIRO_DELETE_DOCUMENT_ITEM

Exclui um item de documento de um quadro. Use quando precisar remover um item de documento (ex.: PDF ou imagem) que não é mais relevante.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único do item de documento a ser excluído.
board_id	string	Sim	Identificador único do quadro que contém o item de documento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de embed

MIRO_DELETE_EMBED_ITEM

Exclui um item de embed de um quadro. Use quando precisar remover um item de conteúdo incorporado (ex.: vídeo do YouTube, site) que não é mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de frame

MIRO_DELETE_FRAME_ITEM

Exclui um item de frame de um quadro Miro. Use quando precisar remover um frame que agrupa ou organiza conteúdo no quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do frame que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o frame.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir grupo

MIRO_DELETE_GROUP

Exclui um grupo de um quadro. Use quando precisar remover um grupo e, opcionalmente, seus itens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro.
group_id	string	Sim	Identificador único (ID) do grupo.
delete_items	boolean	Sim	Indica se os itens devem ser removidos. Defina como true para excluir os itens do grupo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de imagem

MIRO_DELETE_IMAGE_ITEM

Exclui um item de imagem de um quadro. Use quando precisar remover uma imagem que não é mais necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item

MIRO_DELETE_ITEM

Exclui um item específico de um quadro. Use quando precisar remover um item (ex.: forma, nota adesiva) após confirmar os IDs do quadro e do item.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único do item a ser excluído.
board_id	string	Sim	Identificador único do quadro que contém o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir nó de mapa mental (experimental)

MIRO_DELETE_MINDMAP_NODE_EXPERIMENTAL

Exclui um nó de mapa mental de um quadro. Use quando precisar remover um nó de mapa mental após confirmar os IDs do quadro e do item. Este é um endpoint experimental.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do nó de mapa mental que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o nó de mapa mental.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de forma

MIRO_DELETE_SHAPE_ITEM

Exclui um item de forma de um quadro. Use quando precisar remover uma forma específica que não é mais necessária após confirmar os IDs do quadro e do item.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de nota adesiva

MIRO_DELETE_STICKY_NOTE_ITEM

Exclui um item de nota adesiva de um quadro. Use quando precisar remover uma nota adesiva que não é mais necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir tag

MIRO_DELETE_TAG

Exclui uma tag específica de um quadro. Use quando precisar remover uma tag após confirmar os IDs do quadro e da tag.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag_id	string	Sim	Identificador único (ID) da tag que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja excluir a tag.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir item de texto

MIRO_DELETE_TEXT_ITEM

Exclui um item de texto de um quadro. Use quando precisar remover um item de texto após confirmar os IDs do quadro e do item.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja excluir.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja excluir o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todos os grupos

MIRO_GET_ALL_GROUPS

Recupera todos os grupos em um quadro Miro com paginação por cursor. Use quando precisar listar todos os grupos e seus itens associados em um quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de grupos a retornar de uma vez. Padrão: 10, mínimo: 10, máximo: 50.
cursor	string	Não	Cursor para paginação. Use o valor do cursor de uma resposta anterior para recuperar a próxima página de resultados.
board_id	string	Sim	Identificador único (ID) do quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de app card

MIRO_GET_APP_CARD_ITEM2

Recupera um item de app card específico pelo seu ID em um quadro Miro. Use quando precisar obter os detalhes de um item de app card existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter quadro (descontinuado)

MIRO_GET_BOARD

DESCONTINUADO: Use MIRO_GET_SPECIFIC_BOARD em vez desta ação. Recupera detalhes de um quadro específico. Use quando tiver um ID de quadro e precisar buscar seus metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único do quadro a ser recuperado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar itens do quadro

MIRO_GET_BOARD_ITEMS

Lista itens em um quadro Miro (formas, notas adesivas, cards, etc.) com paginação. Use quando precisar percorrer elementos do quadro para análise ou relatórios. Busque novamente antes de atualizações em lote para evitar IDs de itens desatualizados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Não	Filtrar por tipo de item. Valores: ai_generation_result, app_card, card, data_table_format, diagram, doc_format, document, embed, frame, image, mindmap_node, shape, sticky_note, text. Nota: connector não é suportado; use a ação separada Listar conectores.
limit	integer	Não	Número máximo de itens a retornar por página (10-50).
cursor	string	Não	Cursor para paginar resultados; use o valor de uma resposta anterior. Passe o cursor de cada resposta para a próxima chamada; pare quando o cursor for nulo (todos os itens foram recuperados).
board_id	string	Sim	Identificador único do quadro do qual recuperar os itens.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar membros do quadro

MIRO_GET_BOARD_MEMBERS

Recupera uma lista de membros de um quadro. Use quando precisar listar todos os usuários com acesso a um quadro após confirmar seu ID. Os resultados são limitados às permissões do usuário autenticado; membros ou quadros inacessíveis a esse usuário não aparecerão na resposta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de resultados por página (máx. 100).
cursor	string	Não	Cursor para paginação, usado para recuperar páginas subsequentes.
board_id	string	Sim	Identificador único do quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar quadros (descontinuado)

MIRO_GET_BOARDS

DESCONTINUADO: Use MIRO_GET_BOARDS2 em vez desta ação. Recupera quadros acessíveis com filtros opcionais. Use quando precisar listar ou pesquisar quadros por equipe, projeto, proprietário ou palavras-chave. Apenas quadros acessíveis ao usuário autenticado são retornados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem de classificação dos resultados. Valores: default, last_created, last_opened, last_modified, alphabetically.
limit	integer	Não	Número de quadros a retornar por página (1-50). Valores acima de 50 causam erro 400.
owner	string	Não	Filtrar quadros pelo ID do proprietário.
query	string	Não	Consulta de pesquisa para filtrar quadros por nome.
offset	integer	Não	Deslocamento para paginação. Incremente pelo valor de limit até os resultados serem esgotados.
team_id	string	Não	Filtrar quadros pelo ID da equipe.
project_id	string	Não	Filtrar quadros pelo ID do projeto (espaço).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar quadros V2

MIRO_GET_BOARDS2

Recupera quadros acessíveis com filtros opcionais. Use quando precisar listar ou pesquisar quadros por equipe, projeto, proprietário ou palavras-chave com suporte completo a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem de classificação. Opções: default, last_modified, last_opened, last_created, alphabetically. As opções last_created e alphabetically se aplicam apenas quando pesquisar quadros por equipe. Padrão: default.
limit	integer	Não	Número máximo de quadros a recuperar (1-50). Padrão: 20.
owner	string	Não	Recupera quadros de um proprietário específico pelo ID.
query	string	Não	Recupera quadros que contêm o texto de consulta no nome ou descrição.
offset	integer	Não	Deslocamento baseado em zero do primeiro item da coleção. Padrão: 0.
team_id	string	Não	ID da equipe para a qual recuperar a lista de quadros. Se enviado, os parâmetros query e owner são ignorados.
project_id	string	Não	ID do projeto para o qual recuperar a lista de quadros. Se enviado, os parâmetros query e owner são ignorados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de card

MIRO_GET_CARD_ITEM

Recupera um item de card específico de um quadro Miro. Use quando precisar buscar detalhes de um item de card existente pelo seu ID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter conector

MIRO_GET_CONNECTOR

Recupera um conector específico pelo seu ID. Use quando precisar de detalhes sobre um conector existente em um quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o conector.
connector_id	string	Sim	Identificador único (ID) do conector que você deseja recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar conectores

MIRO_GET_CONNECTORS

Recupera uma lista de conectores em um quadro. Use após confirmar o ID do quadro e quando precisar percorrer itens de conector.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de resultados a retornar por chamada (10 a 50). Padrão: 10.
cursor	string	Não	Cursor para paginação para recuperar a próxima página de conectores. Passe o cursor retornado pela resposta anterior para buscar a próxima página; quando a resposta retornar cursor nulo, todas as páginas foram recuperadas.
board_id	string	Sim	Identificador único do quadro do qual recuperar os conectores.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de documento

MIRO_GET_DOCUMENT_ITEM

Recupera um item de documento específico de um quadro Miro pelo seu ID. Use quando precisar obter detalhes sobre um item de documento existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de embed

MIRO_GET_EMBED_ITEM

Recupera um item de embed específico de um quadro pelo seu ID. Use quando precisar de detalhes de um item de conteúdo incorporado existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de frame

MIRO_GET_FRAME_ITEM

Recupera um item de frame específico de um quadro Miro. Use quando precisar buscar detalhes de um frame existente pelo seu ID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do frame que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro que contém o frame que você deseja recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter grupo por ID

MIRO_GET_GROUP_BY_ID

Recupera um grupo específico pelo seu ID. Use quando precisar obter detalhes sobre um grupo em um quadro Miro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro.
group_id	string	Sim	Identificador único (ID) do grupo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de imagem

MIRO_GET_IMAGE_ITEM

Recupera um item de imagem específico de um quadro. Use quando precisar obter detalhes sobre um item de imagem existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter tags de item

MIRO_GET_ITEM_TAGS

Recupera as tags anexadas a um item específico em um quadro Miro. Use quando precisar obter as tags associadas a um item específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único do item do qual recuperar as tags.
board_id	string	Sim	Identificador único do quadro que contém o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter nó de mapa mental

MIRO_GET_MINDMAP_NODE_EXPERIMENTAL

Recupera um nó de mapa mental específico de um quadro. Use quando precisar obter detalhes sobre um nó de mapa mental pelo seu ID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do nó de mapa mental que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o nó de mapa mental.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar nós de mapa mental (experimental)

MIRO_GET_MINDMAP_NODES_EXPERIMENTAL

Recupera nós de mapa mental de um quadro Miro. Use quando precisar acessar a estrutura e o conteúdo de mapas mentais em um quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	string	Não	Número máximo de resultados retornados.
cursor	string	Não	Aponta para a próxima porção do conjunto de resultados. Use o valor do cursor de uma resposta anterior para recuperar a próxima página.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar os nós de mapa mental.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter dados oEmbed

MIRO_GET_OEMBED

Recupera dados oEmbed para um quadro Miro. Use quando precisar gerar código HTML incorporável para um quadro ou obter metadados do quadro no formato oEmbed.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
url	string	Sim	URL apontando para o recurso do quadro Miro a retornar como dados oEmbed. Deve ser uma URL válida de quadro Miro (ex.: https://miro.com/app/board/uXjVJ_fzYUs=).
format	string	Não	Especifica o formato de retorno da resposta. Apenas json é suportado. Padrão: json.
maxwidth	integer	Não	Largura máxima disponível para o embed, em pixels.
referrer	string	Não	URL apontando para a origem da requisição. Usada para rastrear onde o embed será exibido.
maxheight	integer	Não	Altura máxima disponível para o embed, em pixels.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de forma

MIRO_GET_SHAPE_ITEM

Recupera um item de forma específico de um quadro Miro pelo seu ID. Use quando precisar obter detalhes de um item de forma existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter quadro específico

MIRO_GET_SPECIFIC_BOARD

Recupera informações detalhadas sobre um quadro específico pelo seu ID. Use quando precisar buscar metadados completos incluindo equipe, permissões, proprietário e detalhes de modificação de um quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro que você deseja recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter membro específico do quadro

MIRO_GET_SPECIFIC_BOARD_MEMBER

Recupera detalhes de um membro específico do quadro. Use quando tiver um ID de quadro e um ID de membro e precisar obter a função e as informações desse membro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
board_id	string	Sim	Identificador único (ID) do quadro ao qual o membro pertence.
board_member_id	string	Sim	Identificador único (ID) do membro do quadro cuja função você deseja recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item específico

MIRO_GET_SPECIFIC_ITEM

Recupera um item específico de um quadro Miro pelo seu ID. Use quando precisar de detalhes sobre um item específico do quadro (nota adesiva, forma, card, frame, etc.).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de nota adesiva

MIRO_GET_STICKY_NOTE_ITEM

Recupera um item de nota adesiva específico de um quadro pelo seu ID. Use quando precisar obter os detalhes de um item de nota adesiva existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter tag

MIRO_GET_TAG

Recupera detalhes de uma tag específica em um quadro. Use quando tiver um ID de quadro e um ID de tag e precisar dos seus metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag_id	string	Sim	Identificador único da tag a recuperar.
board_id	string	Sim	Identificador único do quadro onde a tag está localizada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter item de texto

MIRO_GET_TEXT_ITEM

Recupera um item de texto específico de um quadro Miro pelo seu ID. Use quando precisar obter os detalhes de um item de texto existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	Identificador único (ID) do item que você deseja recuperar.
board_id	string	Sim	Identificador único (ID) do quadro do qual você deseja recuperar o item.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar tags do quadro

MIRO_LIST_BOARD_TAGS

Lista todas as tags em um quadro Miro. Use quando precisar descobrir IDs, títulos ou cores de tags antes de realizar operações com elas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de tags a retornar por página (mín. 1).
cursor	string	Não	Cursor para paginar resultados; use o valor de uma resposta anterior.
board_id	string	Sim	Identificador único do quadro do qual recuperar as tags.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter contexto da organização

MIRO_LIST_ORGANIZATIONS

Recupera a organização associada ao token de acesso atual. Nota: a API do Miro não possui um endpoint para listar todas as organizações que um usuário tem acesso. Esta ação usa o endpoint /v1/oauth-token para retornar o único contexto de organização associado ao token autenticado, junto com informações de equipe e usuário. Para usuários Enterprise que precisam trabalhar com organizações, use endpoints específicos de organização como MIRO_GET_ORGANIZATION_MEMBERS, que requerem o parâmetro org_id.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Compartilhar quadro

MIRO_SHARE_BOARD

Compartilha um quadro convidando usuários por e-mail. Use quando precisar conceder acesso a um quadro enviando convites por e-mail para novos membros. Você pode convidar até 20 usuários por chamada e atribuir funções a eles.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
role	string	Não	Função dos membros do quadro sendo convidados. Opções: viewer (somente visualização), commenter (visualizar e comentar), editor (visualizar, comentar e editar), coowner (acesso completo exceto alterar proprietário), owner (acesso completo incluindo alterar proprietário). Nota: convidar com a função owner tem o mesmo efeito que coowner.
emails	array	Sim	Endereços de e-mail dos usuários que você deseja convidar para o quadro. Você pode convidar até 20 membros por chamada.
message	string	Não	Mensagem opcional que será enviada no e-mail de convite.
board_id	string	Sim	Identificador único (ID) do quadro para o qual você deseja convidar membros.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de app card

MIRO_UPDATE_APP_CARD_ITEM2

Atualiza um item de app card em um quadro Miro. Use quando precisar modificar propriedades de um app card existente, como título, descrição, status, estilo, posição ou geometria.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para o item de app card.
style	object	Não	Informações de estilo para o item de app card.
parent	object	Não	Informações do frame pai para o item de app card.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Informações geométricas sobre o item de app card.
position	object	Não	Informações de posição para o item de app card.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar quadro

MIRO_UPDATE_BOARD

Atualiza propriedades de um quadro específico. Use quando tiver um ID de quadro e precisar modificar seu nome, descrição ou política de permissões. Use após confirmar que o quadro existe.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Novo nome para o quadro (1-60 caracteres).
policy	object	Não	Define permissões e políticas de compartilhamento do quadro. Contém o subcampo sharingPolicy que aceita valores de enum específicos (ex.: private, view, comment, edit); valores inválidos retornam 400.
teamId	string	Não	ID da equipe onde o quadro deve ser colocado.
boardId	string	Sim	Identificador único (ID) do quadro a atualizar.
projectId	string	Não	ID do projeto (espaço) ao qual o quadro deve ser adicionado.
description	string	Não	Nova descrição para o quadro (até 300 caracteres).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar membro do quadro

MIRO_UPDATE_BOARD_MEMBER

Atualiza a função de um membro específico do quadro. Use quando tiver um ID de quadro e um ID de membro e precisar alterar as permissões ou função desse membro no quadro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
role	string	Não	Função do membro do quadro. Pode ser viewer (somente visualização), commenter (visualizar e comentar), editor (visualizar, comentar e editar), coowner (acesso completo exceto alterar proprietário), owner (acesso completo incluindo alterar proprietário).
board_id	string	Sim	Identificador único (ID) do quadro para o qual você deseja atualizar a função do membro.
board_member_id	string	Sim	Identificador único (ID) do membro do quadro cuja função você deseja atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de card

MIRO_UPDATE_CARD_ITEM

Atualiza um item de card em um quadro Miro. Use quando precisar modificar propriedades de um item de card existente, como título, descrição, data de vencimento, responsável, estilo, posição ou geometria.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Contém dados do item de card a atualizar, como título, descrição, data de vencimento ou ID do responsável.
style	object	Não	Contém informações sobre o estilo do item de card a atualizar, como o tema do card.
parent	object	Não	Contém informações sobre o frame pai do item.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Contém informações geométricas a atualizar sobre o item, como largura ou altura.
position	object	Não	Contém informações de posição a atualizar para o item no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar conector

MIRO_UPDATE_CONNECTOR

Atualiza um conector existente em um quadro Miro. Use quando precisar modificar propriedades do conector, como formato, estilo, legendas ou conexões de extremidade. Apenas os campos fornecidos serão atualizados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
shape	string	Não	Tipo de caminho da linha do conector, define a curvatura. Valores: straight, elbowed, curved. Padrão: curved.
style	object	Não	Propriedades visuais para a linha e legenda do conector.
endItem	object	Não	Define o ponto inicial ou final do conector.
board_id	string	Sim	Identificador único (ID) do quadro para o qual você deseja atualizar o conector.
captions	array	Não	Blocos de texto a exibir no conector. Máximo de 20 legendas permitidas.
startItem	object	Não	Define o ponto inicial ou final do conector.
connector_id	string	Sim	Identificador único (ID) do conector que você deseja atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de documento

MIRO_UPDATE_DOCUMENT_ITEM

Atualiza um item de documento em um quadro Miro. Use quando precisar modificar propriedades de um item de documento existente, como URL, título, posição ou geometria.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados para informações da URL do documento.
parent	object	Não	Referência ao elemento pai para posicionamento hierárquico.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Propriedades geométricas para o item de documento. Você pode definir largura ou altura, não ambos.
position	object	Não	Informações de posicionamento do item de documento no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de embed

MIRO_UPDATE_EMBED_ITEM

Atualiza um item de embed em um quadro. Use quando precisar modificar propriedades de um item de conteúdo incorporado existente, como posição, modo de exibição ou URL.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Campos de dados para atualizar o item de embed.
parent	object	Não	Contém informações sobre o frame pai do item.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Contém informações geométricas sobre o item. Você pode definir largura ou altura, mas não ambos ao mesmo tempo.
position	object	Não	Contém informações sobre a posição do item no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de frame

MIRO_UPDATE_FRAME_ITEM

Atualiza um item de frame em um quadro Miro. Use quando precisar modificar propriedades de um frame existente, como título, posição, tamanho ou estilo. Inclua apenas os campos a serem alterados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para atualizar o item de frame.
style	object	Não	Opções de estilo para atualizar o item de frame.
item_id	string	Sim	Identificador único (ID) do frame que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o frame.
geometry	object	Não	Dimensões geométricas para atualizar o item de frame.
position	object	Não	Posição no quadro para atualizar o item de frame.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar grupo

MIRO_UPDATE_GROUP

Atualiza um grupo em um quadro Miro com novos itens. Use quando precisar alterar quais itens pertencem a um grupo existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Contém os dados com os IDs dos itens a incluir no grupo.
board_id	string	Sim	Identificador único (ID) do quadro.
group_id	string	Sim	Identificador único (ID) do grupo a atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de imagem

MIRO_UPDATE_IMAGE_ITEM

Atualiza um item de imagem existente em um quadro. Use quando precisar modificar propriedades de um item de imagem existente, como título, URL, posição ou geometria.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Campos de dados a atualizar para o item de imagem.
parent	object	Não	Contém informações sobre o frame pai do item.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Contém informações geométricas sobre o item. Você pode definir largura ou altura, não ambos ao mesmo tempo.
position	object	Não	Contém informações sobre a posição do item no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar posição ou pai do item

MIRO_UPDATE_ITEM_POSITION_OR_PARENT

Atualiza a posição ou o frame pai de um item em um quadro Miro. Use quando precisar mover um item para um novo local ou atribuí-lo a um frame pai diferente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	object	Não	Informações do frame pai para atualizar um item no quadro.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
position	object	Não	Informações de posição para atualizar um item no quadro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de forma

MIRO_UPDATE_SHAPE_ITEM

Atualiza um item de forma existente em um quadro Miro. Use quando precisar modificar propriedades de uma forma, como conteúdo, estilo, posição, geometria ou pai. Inclua apenas os campos que deseja alterar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Dados principais para atualizar o item de forma.
style	object	Não	Opções de estilo para atualizar o item de forma.
parent	object	Não	Referência ao item pai para atualizar o aninhamento da forma.
item_id	string	Sim	Identificador único do item de forma a atualizar.
board_id	string	Sim	Identificador único do quadro que contém o item de forma.
geometry	object	Não	Dimensões geométricas para atualizar o item de forma.
position	object	Não	Posição no quadro para atualizar o item de forma.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de nota adesiva

MIRO_UPDATE_STICKY_NOTE_ITEM

Atualiza um item de nota adesiva em um quadro Miro. Use quando precisar modificar o conteúdo, estilo, posição, geometria ou pai de uma nota adesiva existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Contém dados do item de nota adesiva, como conteúdo ou forma.
style	object	Não	Contém informações sobre o estilo do item de nota adesiva, como cor de preenchimento ou alinhamento de texto.
parent	object	Não	Contém informações sobre o frame pai do item.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Contém informações geométricas sobre o item. Você pode definir largura ou altura, não ambos ao mesmo tempo.
position	object	Não	Contém informações sobre a posição do item no quadro, como coordenadas x e y.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar tag

MIRO_UPDATE_TAG

Atualiza uma tag em um quadro. Use quando precisar modificar o título ou a cor de uma tag. Pelo menos um campo (title ou fillColor) deve ser fornecido para atualizar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Não	Texto da tag. Diferencia maiúsculas de minúsculas. Deve ser único dentro do quadro.
tag_id	string	Sim	Identificador único (ID) da tag que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar a tag.
fillColor	string	Não	Cor de preenchimento da tag. Opções: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar item de texto

MIRO_UPDATE_TEXT_ITEM

Atualiza um item de texto em um quadro Miro. Use quando precisar modificar o conteúdo, estilo, posição ou outras propriedades de um item de texto existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Não	Contém dados do item de texto a atualizar.
style	object	Não	Contém informações sobre o estilo do item de texto a atualizar.
parent	object	Não	Contém informações sobre o frame pai do item.
item_id	string	Sim	Identificador único (ID) do item que você deseja atualizar.
board_id	string	Sim	Identificador único (ID) do quadro onde você deseja atualizar o item.
geometry	object	Não	Contém informações geométricas sobre o item a atualizar.
position	object	Não	Contém informações sobre a posição do item no quadro a atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.