List boards with the Miro API
Lists the boards the connected user can open, with id, name, description, viewLink, owner, team and dates. Pagination by offset: the response has total, offset and size, and the list ends when offset plus size reaches total. Boards created a few seconds ago may be missing from a text search, but not from a search by team_id.
- Identifier
- miro_list_boards
The request
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>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | No | Text matched against the name and description of the boards. Ignored when team_id is sent. |
| team_id | string | No | 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 | No | Order of the boards. It only applies with team_id; default means last_created there.Values: default, last_modified, last_opened, last_created, alphabetically |
| limit | integer | No | Boards per page, up to 50. The default is 20. |
| offset | integer | No | Zero-based position of the first board to return. The default is 0. |
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_boards. It becomes your agent's tool definition with no conversion.
Other Miro tools
- Get boardGETReturns a board: name, description, viewLink, owner, team, sharing policy and dates.
- Create boardPOSTCreates a board in the team of the connection and returns it with its id and viewLink. On the free plan a team can have only 3 editable boards.
- Update boardPATCHUpdates the name, description or sharing of a board and returns it. Fields left out keep their value.
- List board membersGETLists the members of a board with id, name and role. The id is the assigneeId that Create card and Update card ask for. Pagination by offset: the list ends when offset plus size reaches total.
- List itemsGETLists 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.
- Get itemGETReturns one item of a board, of any type, with its data, style, position, geometry and parent.
- Create sticky notePOSTAdds a sticky note to a board and returns it with its id. Without position it goes to the center of the board; inside a frame (parent.id), the position counts from the top-left corner of the frame.
- Update sticky notePATCHUpdates the text, shape, color, position, size or frame of a sticky note and returns it. Fields left out keep their value.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
