Miro integration

Whiteboard: boards, cards, sticky notes, shapes, connectors, members, tags

Help CentreConnectors

Overview

Miro is a collaborative whiteboard platform. The Automize Miro connector covers boards, cards, sticky notes, shapes, connectors, members, tags.

  • Regions: Global SaaS.
  • Plans: Free + paid.

Setting up the connection

Auth type: Bearer Token.

  1. Miro Developers → create app → OAuth or personal token.
  2. In Automize → Settings → Connectors → Miro. Paste token.

Find your credentials at https://miro.com/app/settings/team/profile/apps/.


Rate limits

~3 req/sec.


Data model

Whiteboard primitives:

    Team ─── Boards ─┬─ Items (cards, sticky notes, shapes, text, frames)
                     ├─ Connectors (lines between items)
                     ├─ Members (collaborators)
                     └─ Tags

Available operations

9 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Create BoardGeneralCreate a new board
Create CardGeneralAdd a card to a board
Create ShapeGeneralAdd a shape to a board
Create Sticky NoteGeneralAdd a sticky note to a board
Get BoardGeneralGet board details
List BoardsGeneralList all boards
List ItemsGeneralList items on a board
List MembersGeneralList board members
List TagsGeneralList board tags

Operations

Create Board

Create a new board

ParameterRequiredTypeDescription
Name nameYestext
Description descriptionYestext
Policy policyYestext

Create Card

Add a card to a board

ParameterRequiredTypeDescription
Board Id board_idYestext
Data dataYestextarea
Style styleYestext
Position positionYestext

Tips

  • Title + description + assignee + due date.

Create Shape

Add a shape to a board

ParameterRequiredTypeDescription
Board Id board_idYestext
Data dataYestextarea
Style styleYestext
Position positionYestext

Create Sticky Note

Add a sticky note to a board

ParameterRequiredTypeDescription
Board Id board_idYestext
Data dataYestextarea
Style styleYestext
Position positionYestext

Tips

  • board_id + content + position (x, y) + color.

Get Board

Get board details

ParameterRequiredTypeDescription
Board Id board_idYestext

List Boards

List all boards

No input parameters.

Tips

  • Team's boards. Filter by name, owner.

List Items

List items on a board

ParameterRequiredTypeDescription
Board Id board_idYestext

Tips

  • Per board. Filter by type (card, sticky_note, shape, etc.).

List Members

List board members

ParameterRequiredTypeDescription
Board Id board_idYestext

Tips

  • Board's collaborators + roles.

List Tags

List board tags

ParameterRequiredTypeDescription
Board Id board_idYestext

FAQ

Use cases?
Sync sprint planning, design reviews, retros to/from external systems. Automated board population from project data.

Related connectors

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.