Listar boards no Miro, por uma API
Lista os boards que o usuário conectado pode abrir, com id, name, description, viewLink, owner, team e datas. Paginação por offset.
- Identificador
- miro_list_boards
A chamada
POST https://connect.reportei.com/api/tools/miro_list_boards/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"query": "<query>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| query | string | Não | Text matched against the name and description of the boards. Ignored when team_id is sent. |
| team_id | string | Não | Only the boards of this team: the team.id of a board from List boards. With it, query is ignored and sort applies. |
| sort | string | Não | Order of the boards. It only applies with team_id; default means last_created there.Valores: default, last_modified, last_opened, last_created, alphabetically |
| limit | integer | Não | Boards per page, up to 50. The default is 20. |
| offset | integer | Não | Zero-based position of the first board to return. The default is 0. |
Conexões possíveis
O seu cliente conecta a conta do Miro uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/miro, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/miro_list_boards. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Miro
- Obter boardGETDevolve um board: name, description, viewLink, owner, team, política de compartilhamento e datas.
- Criar boardPOSTCria um board no time da conexão e o devolve com id e viewLink. No plano gratuito um time pode ter só 3 boards editáveis.
- Atualizar boardPATCHAtualiza o nome, a descrição ou o compartilhamento de um board e o devolve. Campos omitidos mantêm o valor.
- Listar membros do boardGETLista os membros de um board com id, name e role. O id é o assigneeId que Criar card e Atualizar card pedem. Paginação por offset.
- Listar itensGETLista os itens de um board, como sticky notes, cards, textos, formas e frames, com id, type, data, position, geometry e parent.
- Obter itemGETDevolve um item de um board, de qualquer tipo, com data, style, position, geometry e parent.
- Criar sticky notePOSTAdiciona uma sticky note a um board e a devolve com seu id. Sem position ela vai para o centro do board; dentro de um frame (parent.id), a posição conta a partir do frame.
- Atualizar sticky notePATCHAtualiza o texto, formato, cor, posição, tamanho ou frame de uma sticky note e a devolve. Campos omitidos mantêm o valor.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
