Miro REST API

The Miro REST API enables programmatic access to create, read, update, and delete boards, items, users, and team resources. This skill provides comprehensive documentation for integrating Miro with external systems, automating workflows, and building custom applications.

Quick Start

Base URL: https://api.miro.com/v2

Authentication: OAuth 2.0 or Personal Access Tokens

Example Request:

curl -X GET https://api.miro.com/v2/boards \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Response:

{
  "data": [
    {
      "id": "board-id-123",
      "name": "My Board",
      "owner": {"id": "user-id", "email": "[email protected]"},
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ]
}

Core Capabilities

1. Board Management

• List boards - Get all boards in your workspace
• Create boards - Programmatically create new boards
• Update board settings - Modify name, sharing, permissions
• Delete boards - Soft-delete boards (recoverable)
• Board sharing & access - Manage team member permissions

2. Items (Cards, Shapes, Text, Stickies)

• Create items - Add cards, shapes, text, stickies, images to boards
• Read items - Fetch item details, properties, attachments
• Update items - Modify content, position, style, metadata
• Delete items - Remove items from boards
• Batch operations - Efficient bulk create/update

3. Shapes & Connectors

• Shape library - Rectangle, circle, diamond, line, arrow, etc.
• Shape styling - Fill color, stroke, line width, opacity
• Connectors - Create connections between shapes
• Geometry - Position, rotation, dimensions

4. Text & Rich Content

• Text shapes - Add formatted text to boards
• Rich text - Bold, italic, underline, font sizes
• Text alignment - Left, center, right, justified
• Font families - System fonts and custom typefaces

5. Images & Files

• Upload images - Add images to boards
• Image management - Reference, replace, delete
• Attachments - Embed files and URLs

6. Frames & Grouping

• Frames - Organizational containers for items
• Groups - Logical grouping of related items
• Hierarchy - Nested structures and relationships

7. Comments & Collaboration

• Add comments - Comment on boards and items
• Thread replies - Nested comment threads
• Mentions - Tag team members (@username)
• Comment reactions - Emoji reactions to comments

8. Users & Team Management

• List team members - Get users in workspace
• User profiles - Email, name, role, permissions
• Invitations - Invite users to workspace
• Team settings - Manage workspace configuration