Lister les éléments avec l'API Miro

Liste les éléments d'un board, comme sticky notes, cards, textes, formes et frames, avec id, type, data, position, geometry et parent.

Identifiant
miro_list_items

L'appel

POST https://connect.reportei.com/api/tools/miro_list_items/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "board_id": "<board_id>"
  }
}

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ètreTypeObligatoireDescription
board_idstringOuiId of the board, from List boards, or the part after /board/ in the URL of the board, which usually ends with an equals sign.
typestringNonOnly the items of this type. Omit it for all of them.Valeurs : text, shape, sticky_note, image, document, card, app_card, preview, frame, embed, doc_format, data_table_format
limitintegerNonItems per page, from 10 to 50. The default is 10.
cursorstringNonThe cursor of the previous response, to read the next page.

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_items. Il devient la définition de tool de votre agent sans conversion.

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.