Miro is an online collaborative whiteboard used by distributed teams for brainstorming, diagramming, and workshops. The Miro REST API exposes boards, board items (sticky notes, cards, shapes, frames, images, embeds, etc.), connectors, tags, mind maps, members, organizations, teams, webhooks, audit logs, and SCIM provisioning. Miro also offers a Web SDK for in-board apps.
APIs.json: https://raw.githubusercontent.com/api-evangelist/miro/refs/heads/main/apis.yml
- Productivity
- Whiteboard
- Visual Collaboration
- Diagramming
- SaaS
- Created: 2026-05-08
- Modified: 2026-05-19
Create, read, update, copy, and delete Miro boards. Boards are the top-level container for whiteboard content within a team or workspace.
- Human URL: https://developers.miro.com/reference/boards
- Base URL:
https://api.miro.com/v2
- Boards
- CRUD
- API Reference
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Generic and per-type endpoints for board items: sticky notes, cards, shapes, text, frames, images, documents, embeds, and app cards. CRUD on items, with type-specific create/update endpoints for each item kind.
- Human URL: https://developers.miro.com/reference/items
- Base URL:
https://api.miro.com/v2
- Items
- Sticky Notes
- Shapes
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage connectors (lines/arrows) between board items, including style and shape options for diagramming workflows.
- Human URL: https://developers.miro.com/reference/connectors
- Base URL:
https://api.miro.com/v2
- Connectors
- Diagramming
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create, attach, and remove tags on board items for searching, filtering, and grouping.
- Human URL: https://developers.miro.com/reference/tags
- Base URL:
https://api.miro.com/v2
- Tags
- Metadata
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage mind-map nodes and parent-child relationships on a board.
- Human URL: https://developers.miro.com/reference/mindmap-nodes
- Base URL:
https://api.miro.com/v2
- Mind Map
- Diagramming
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Manage who has access to a board and what role (owner, editor, commenter, viewer) they hold.
- Human URL: https://developers.miro.com/reference/board-members
- Base URL:
https://api.miro.com/v2
- Members
- Sharing
- Permissions
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Subscribe to board events (item created/updated/deleted, board events) and receive HTTP callbacks at your endpoint.
- Human URL: https://developers.miro.com/reference/webhooks
- Base URL:
https://api.miro.com/v2
- Webhooks
- Events
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Enterprise-only endpoints to manage the organization, list members, and inspect organization-wide membership and licensing.
- Human URL: https://developers.miro.com/reference/enterprise-organization
- Base URL:
https://api.miro.com/v2
- Organization
- Enterprise
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Manage teams, team members, team settings, and default team roles within an organization.
- Human URL: https://developers.miro.com/reference/enterprise-teams
- Base URL:
https://api.miro.com/v2
- Teams
- Membership
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Enterprise audit-log endpoints. Query user, board, and admin actions for compliance and security monitoring.
- Human URL: https://developers.miro.com/reference/audit-logs
- Base URL:
https://api.miro.com/v2
- Audit
- Compliance
- Enterprise
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
SCIM 2.0 provisioning for Enterprise customers. Automate user/group lifecycle from Okta, Azure AD, OneLogin, and other IdPs.
- Human URL: https://developers.miro.com/reference/scim-api
- Base URL:
https://miro.com/api/v1/scim
- SCIM
- Identity
- Provisioning
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Build apps that run inside the Miro board UI. The Web SDK lets your app create and modify board items, react to events, render custom panels, and integrate with the user's workspace.
- Human URL: https://developers.miro.com/docs/build-your-first-hello-world-app
- Base URL:
https://miro.com
- SDK
- Browser
- Apps
- Documentation
- Git Hub
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
FN: Kin Lane Email: kin@apievangelist.com