List items with the Miro API

Lists the items of a board, such as sticky notes, cards, text, shapes and frames, with id, type, data, position, geometry and parent. An item inside a frame has the id of the frame in parent.id. The response has cursor: pass it as cursor to read the next page; the list ends when cursor is missing.

Identifier
miro_list_items

The request

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>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
board_idstringYesId of the board, from List boards, or the part after /board/ in the URL of the board, which usually ends with an equals sign.
typestringNoOnly the items of this type. Omit it for all of them.Values: text, shape, sticky_note, image, document, card, app_card, preview, frame, embed, doc_format, data_table_format
limitintegerNoItems per page, from 10 to 50. The default is 10.
cursorstringNoThe cursor of the previous response, to read the next page.

Supported connections

Your customer connects their Miro account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/miro, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/miro_list_items. It becomes your agent's tool definition with no conversion.

Other Miro tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.