Lister les boards avec l'API Miro
Liste les boards que l'utilisateur connecté peut ouvrir, avec id, name, description, viewLink, owner, team et dates. Pagination par offset.
- Identifiant
- miro_list_boards
L'appel
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>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| query | string | Non | Text matched against the name and description of the boards. Ignored when team_id is sent. |
| team_id | string | Non | 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 | Non | Order of the boards. It only applies with team_id; default means last_created there.Valeurs : default, last_modified, last_opened, last_created, alphabetically |
| limit | integer | Non | Boards per page, up to 50. The default is 20. |
| offset | integer | Non | Zero-based position of the first board to return. The default is 0. |
Connexions possibles
Votre client connecte son compte Miro une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/miro, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/miro_list_boards. Il devient la définition de tool de votre agent sans conversion.
Autres tools Miro
- Obtenir un boardGETRenvoie un board : name, description, viewLink, owner, team, politique de partage et dates.
- Créer un boardPOSTCrée un board dans l'équipe de la connexion et le renvoie avec id et viewLink. Sur l'offre gratuite une équipe ne peut avoir que 3 boards modifiables.
- Mettre à jour un boardPATCHMet à jour le nom, la description ou le partage d'un board et le renvoie. Les champs omis gardent leur valeur.
- Lister les membres d'un boardGETListe les membres d'un board avec id, name et role. L'id est l'assigneeId que demandent Créer une card et Mettre à jour une card. Pagination par offset.
- Lister les élémentsGETListe les éléments d'un board, comme sticky notes, cards, textes, formes et frames, avec id, type, data, position, geometry et parent.
- Obtenir un élémentGETRenvoie un élément d'un board, de n'importe quel type, avec data, style, position, geometry et parent.
- Créer une sticky notePOSTAjoute une sticky note à un board et la renvoie avec son id. Sans position elle va au centre du board ; dans un frame (parent.id), la position se compte depuis le frame.
- Mettre à jour une sticky notePATCHMet à jour le texte, la forme, la couleur, la position, la taille ou le frame d'une sticky note et la renvoie. Les champs omis gardent leur valeur.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
