Miro connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Miro credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the Miro connector so Scalekit handles the OAuth flow and token lifecycle for your users. Follow every step below from start to finish — by the end you will have a working connection.

   1. Create a Miro app

      You need a Miro OAuth app to get the Client ID and Client Secret that Scalekit will use to authorize your users.

      Go to the Miro Developer Portal:

      • Open miro.com/app/settings/user-profile/apps in your browser.
      • Sign in with the Miro account you use to manage your integration.
      • After signing in, you land on the My Apps page.

      Create a new app:

      • Click Create New App (top right of the page).

      • Fill in the form:

        Field	What to enter
        App Name	A recognizable name, e.g. My AI Collaboration Agent
        App Description	Brief description, e.g. AI agent for managing Miro boards
        Homepage URL	Your app’s public URL. For testing you can use https://localhost
        Grant Type	Select Authorization Code — this is required for OAuth 2.0

      • Leave Redirect URIs blank for now. You will add it in the next step.

      • Click Create App.

      After the app is created, Miro takes you to the app’s OAuth Settings page. Keep this tab open.

      

   2. Copy the redirect URI from Scalekit

      Scalekit gives you a callback URL that Miro will redirect users back to after they authorize your app. You need to register this URL in your Miro app.

      In the Scalekit dashboard:

      • Go to app.scalekit.com and sign in.
      • In the left sidebar, click AgentKit.
      • Click Create Connection.
      • Search for Miro and click Create.
      • A connection details panel opens. Find the Redirect URI field — it looks like:

        https://<YOUR_ENV>.scalekit.cloud/sso/v1/oauth/conn_<ID>/callback

      • Click the copy icon next to the Redirect URI to copy it to your clipboard.

      

   3. Register the redirect URI and copy credentials

      Switch back to the Miro Developer Portal tab.

      • Make sure you are on the OAuth Settings page of your app.
      • Scroll to the Redirect URIs section.
      • Paste the redirect URI you copied from Scalekit into the input box and click Add URI.
      • Click Save Changes at the bottom of the page.

      Copy your credentials:

      • Scroll to OAuth Credentials at the top of the page.
      • Client ID — shown in plain text. Click Copy ID to copy it.
      • Client Secret — click Reveal to show the secret, then copy it.

      Keep both values in a password manager or secrets vault. You will enter them into Scalekit in the next step.

      

      Client secret is shown only once

      The Client Secret is masked after initial creation. If you lose it, you must generate a new one in the Miro app settings — this invalidates all existing connections until you update them in Scalekit.

      Redirect URI must match exactly

      The redirect URI must match character-for-character — including the https:// prefix and the full path. Any mismatch causes a redirect_uri_mismatch error during the OAuth flow.

   4. Configure permissions (scopes)

      Scopes control which Miro resources your app can access on behalf of each user. You select the scopes in Scalekit when saving your credentials.

      Scope	Access granted	Plan required
      boards:read	Read boards, members, and all board items	All plans
      boards:write	Create, update, and delete boards, members, and items	All plans
      identity:read	Read current user profile including email	All plans
      team:read	Read current team information	All plans
      auditlogs:read	Read audit logs for the organization	Enterprise only
      organizations:read	Read organization information	Enterprise only
      organizations:teams:read	Read teams within an organization	Enterprise only
      organizations:teams:write	Create and manage teams within an organization	Enterprise only
      projects:read	Read projects within teams	Enterprise only
      projects:write	Create and manage projects within teams	Enterprise only

      For most integrations, boards:read and boards:write are sufficient.

      Request only what you need

      Users see a list of requested permissions on the Miro authorization screen. Fewer scopes increases trust and approval rates. Only enable the scopes your integration actually uses.

   5. Add credentials in Scalekit

      Switch back to the Scalekit dashboard tab.

      • Go to AgentKit > Connections and open the Miro connection you created in step 2.

      • Fill in the credentials form:

        Field	Value
        Client ID	Paste the Client ID from step 3
        Client Secret	Paste the Client Secret from step 3
        Permissions	Enter the scopes your app needs, e.g. boards:read boards:write

      • Click Save.

      

      Your Miro connection is now configured. Scalekit will use these credentials to run the OAuth flow whenever a user connects their Miro account.

      Scopes must match in both places

      The scopes entered here must match what you enable in your Miro app. A mismatch causes an invalid_scope error when users try to authorize. If you add more scopes later, update both your Miro app and this Scalekit connection.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'miro'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Miro:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'miro_boards_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "miro"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Miro:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="miro_boards_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• List board members, tags, mindmap nodes — Returns a list of members on a Miro board
• Get connector, image, group items — Retrieves details of a specific connector (line/arrow) on a Miro board
• Create shape, embed, frame — Creates a shape item on a Miro board
• Remove item tag, board member — Removes a tag from a specific item on a Miro board
• Invite team member — Invites a user to a team by email (Enterprise only)
• Delete team, item, sticky note — Deletes a team from an organization (Enterprise only)

Common workflows

Proxy API call

Node.js

// Example: list boards
const boards = await actions.request({
  connectionName: 'miro',
  identifier: 'user_123',
  path: '/v2/boards',
  method: 'GET',
});
console.log('Boards:', boards);

// Example: create a sticky note on a board
const stickyNote = await actions.request({
  connectionName: 'miro',
  identifier: 'user_123',
  path: '/v2/boards/YOUR_BOARD_ID/sticky_notes',
  method: 'POST',
  body: {
    data: { content: 'Hello from my AI agent!' },
    style: { fillColor: 'yellow' },
  },
});
console.log('Sticky note created:', stickyNote);

Python

# Example: list boards
boards = actions.request(
    connection_name='miro',
    identifier='user_123',
    path="/v2/boards",
    method="GET"
)
print("Boards:", boards)

# Example: create a sticky note on a board
sticky_note = actions.request(
    connection_name='miro',
    identifier='user_123',
    path="/v2/boards/YOUR_BOARD_ID/sticky_notes",
    method="POST",
    body={
        "data": {"content": "Hello from my AI agent!"},
        "style": {"fillColor": "yellow"},
    }
)
print("Sticky note created:", sticky_note)

Execute a tool

Node.js

const result = await actions.executeTool({
  connector: 'miro',
  identifier: 'user_123',
  toolName: 'miro_app_card_create',
  toolInput: {},
});
console.log(result);

Python

result = actions.execute_tool(
    connection_name='miro',
    identifier='user_123',
    tool_name='miro_app_card_create',
    tool_input={},
)
print(result)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

miro_app_card_create#Creates an app card item on a Miro board.8 params▾

Creates an app card item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

descriptionstringoptionalDescription of the app card.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

statusstringoptionalStatus: disconnected | connected | disabled.

titlestringoptionalTitle of the app card.

widthnumberoptionalWidth in board units.

miro_app_card_delete#Deletes an app card item from a Miro board.2 params▾

Deletes an app card item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_app_card_get#Retrieves an app card item from a Miro board.2 params▾

Retrieves an app card item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_app_card_update#Updates an existing app card item on a Miro board.9 params▾

Updates an existing app card item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

descriptionstringoptionalDescription of the app card.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

statusstringoptionalStatus: disconnected | connected | disabled.

titlestringoptionalTitle of the app card.

widthnumberoptionalWidth in board units.

miro_audit_logs_get#Retrieves audit logs for the organization (Enterprise only). Returns events for the specified date range (max 90 days).5 params▾

Retrieves audit logs for the organization (Enterprise only). Returns events for the specified date range (max 90 days).

NameTypeRequiredDescription

created_afterstringrequiredStart of date range in ISO 8601.

created_beforestringrequiredEnd of date range in ISO 8601.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results per page (1-100).

sortingstringoptionalSort order: asc | desc.

miro_board_copy#Creates a copy of an existing Miro board, optionally in a different team.2 params▾

Creates a copy of an existing Miro board, optionally in a different team.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board to copy.

team_idstringoptionalTeam ID to copy the board into. Defaults to the original board's team.

miro_board_create#Creates a new Miro board. If no name is provided, Miro defaults to 'Untitled'.4 params▾

Creates a new Miro board. If no name is provided, Miro defaults to 'Untitled'.

NameTypeRequiredDescription

descriptionstringoptionalBoard description (max 300 characters).

namestringoptionalBoard name (max 60 characters).

project_idstringoptionalID of the project/Space to add the board to.

team_idstringoptionalID of the team to create the board in.

miro_board_delete#Permanently deletes a Miro board and all its contents.1 param▾

Permanently deletes a Miro board and all its contents.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board to delete.

miro_board_export_create#Creates a board export job for eDiscovery (Enterprise only). Returns a job ID to poll for status.4 params▾

Creates a board export job for eDiscovery (Enterprise only). Returns a job ID to poll for status.

NameTypeRequiredDescription

board_idsstringrequiredJSON array of board IDs to export, e.g. ["id1","id2"]

org_idstringrequiredOrganization ID.

request_idstringrequiredUnique request ID (UUID) to identify this export job.

formatstringoptionalExport format: pdf | csv.

miro_board_export_job_get#Gets the status of a board export job (Enterprise only).2 params▾

Gets the status of a board export job (Enterprise only).

NameTypeRequiredDescription

job_idstringrequiredExport job ID.

org_idstringrequiredOrganization ID.

miro_board_export_job_results_get#Retrieves the results/download URLs of a completed board export job (Enterprise only).2 params▾

Retrieves the results/download URLs of a completed board export job (Enterprise only).

NameTypeRequiredDescription

job_idstringrequiredExport job ID.

org_idstringrequiredOrganization ID.

miro_board_export_jobs_list#Lists all board export jobs for an organization (Enterprise only).3 params▾

Lists all board export jobs for an organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results.

miro_board_get#Retrieves details of a specific Miro board by its ID.1 param▾

Retrieves details of a specific Miro board by its ID.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the Miro board.

miro_board_member_get#Retrieves details of a specific member on a Miro board.2 params▾

Retrieves details of a specific member on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

member_idstringrequiredUnique identifier of the board member.

miro_board_member_remove#Removes a member from a Miro board.2 params▾

Removes a member from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

member_idstringrequiredUnique identifier of the member to remove.

miro_board_member_update#Updates the role of a member on a Miro board.3 params▾

Updates the role of a member on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

member_idstringrequiredUnique identifier of the board member to update.

rolestringrequiredNew role for the member. Valid values: viewer, commenter, editor, coowner.

miro_board_members_list#Returns a list of members on a Miro board.1 param▾

Returns a list of members on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

miro_board_members_share#Shares a Miro board with one or more users by email address, assigning them a role.3 params▾

Shares a Miro board with one or more users by email address, assigning them a role.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board to share.

emailsstringrequiredJSON array of email addresses to invite.

rolestringrequiredRole to assign to the invited users. Valid values: viewer, commenter, editor, coowner.

miro_board_update#Updates the name or description of a Miro board.3 params▾

Updates the name or description of a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board to update.

descriptionstringoptionalNew board description (max 300 characters).

namestringoptionalNew board name (max 60 characters).

miro_boards_list#Returns a list of Miro boards the authenticated user has access to. Supports filtering by team, project, owner, and search query.0 params▾

Returns a list of Miro boards the authenticated user has access to. Supports filtering by team, project, owner, and search query.

miro_card_create#Creates a card item on a Miro board. Cards can have a title, description, assignee, and due date.10 params▾

Creates a card item on a Miro board. Cards can have a title, description, assignee, and due date.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

assignee_idstringoptionalUser ID to assign the card to.

card_themestringoptionalCard theme color as hex code (e.g. #2d9bf0).

descriptionstringoptionalDescription/body text of the card.

due_datestringoptionalDue date in ISO 8601 format (e.g. 2024-12-31T23:59:59Z).

parent_idstringoptionalID of a parent frame to place the card inside.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

titlestringoptionalTitle of the card.

widthnumberoptionalWidth of the card in board units.

miro_card_delete#Deletes a card item from a Miro board.2 params▾

Deletes a card item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the card to delete.

miro_card_get#Retrieves details of a specific card item on a Miro board.2 params▾

Retrieves details of a specific card item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the card item.

miro_card_update#Updates the content, assignment, due date, or position of a card on a Miro board.8 params▾

Updates the content, assignment, due date, or position of a card on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the card to update.

assignee_idstringoptionalUpdated assignee user ID.

descriptionstringoptionalUpdated card description.

due_datestringoptionalUpdated due date in ISO 8601 format.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

titlestringoptionalUpdated card title.

miro_connector_create#Creates a connector (line/arrow) between two existing items on a Miro board.11 params▾

Creates a connector (line/arrow) between two existing items on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

end_item_idstringrequiredID of the item where the connector ends.

start_item_idstringrequiredID of the item where the connector starts.

captionstringoptionalText label to display on the connector.

end_snap_tostringoptionalAttachment point on the end item. Valid values: auto, top, right, bottom, left.

end_stroke_capstringoptionalEnd endpoint cap style. Valid values: none, arrow, filled_arrow, circle, filled_circle, diamond, filled_diamond, bar, stealth.

shapestringoptionalConnector line style. Valid values: straight, elbowed, curved.

start_snap_tostringoptionalAttachment point on the start item. Valid values: auto, top, right, bottom, left.

start_stroke_capstringoptionalStart endpoint cap style. Valid values: none, arrow, filled_arrow, circle, filled_circle, diamond, filled_diamond, bar, stealth.

stroke_colorstringoptionalLine color as hex code.

stroke_widthstringoptionalLine thickness as a string number.

miro_connector_delete#Deletes a connector (line/arrow) from a Miro board.2 params▾

Deletes a connector (line/arrow) from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

connector_idstringrequiredUnique identifier of the connector to delete.

miro_connector_get#Retrieves details of a specific connector (line/arrow) on a Miro board.2 params▾

Retrieves details of a specific connector (line/arrow) on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

connector_idstringrequiredUnique identifier of the connector.

miro_connector_update#Updates the style, shape, or endpoints of a connector on a Miro board.7 params▾

Updates the style, shape, or endpoints of a connector on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

connector_idstringrequiredUnique identifier of the connector to update.

captionstringoptionalUpdated text label on the connector.

end_stroke_capstringoptionalUpdated end endpoint cap style (e.g. arrow, none, filled_arrow).

shapestringoptionalUpdated line style. Valid values: straight, elbowed, curved.

stroke_colorstringoptionalUpdated line color as hex code.

stroke_widthstringoptionalUpdated line thickness as a string number.

miro_connectors_list#Returns all connector (line/arrow) items on a Miro board.2 params▾

Returns all connector (line/arrow) items on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

cursorstringoptionalCursor token from a previous response for pagination.

miro_data_classification_board_get#Retrieves the data classification label for a specific board (Enterprise only).3 params▾

Retrieves the data classification label for a specific board (Enterprise only).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_data_classification_board_set#Sets the data classification label for a specific board (Enterprise only).4 params▾

Sets the data classification label for a specific board (Enterprise only).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

label_idstringrequiredClassification label ID.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_data_classification_org_get#Retrieves data classification label settings for the organization (Enterprise only).1 param▾

Retrieves data classification label settings for the organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

miro_data_classification_team_get#Retrieves data classification settings for a team (Enterprise only).2 params▾

Retrieves data classification settings for a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_document_create#Creates a document item on a Miro board from a publicly accessible URL.8 params▾

Creates a document item on a Miro board from a publicly accessible URL.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

urlstringrequiredPublicly accessible URL of the document.

heightnumberoptionalHeight in board units.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

titlestringoptionalTitle of the document item.

widthnumberoptionalWidth in board units.

miro_document_delete#Deletes a document item from a Miro board.2 params▾

Deletes a document item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_document_get#Retrieves a document item from a Miro board.2 params▾

Retrieves a document item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_document_update#Updates an existing document item on a Miro board.9 params▾

Updates an existing document item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

heightnumberoptionalHeight in board units.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

titlestringoptionalTitle of the document item.

urlstringoptionalNew URL for the document.

widthnumberoptionalWidth in board units.

miro_embed_create#Creates an embed item on a Miro board from an oEmbed-compatible URL (YouTube, Vimeo, etc.).9 params▾

Creates an embed item on a Miro board from an oEmbed-compatible URL (YouTube, Vimeo, etc.).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

urlstringrequiredURL of the content to embed (oEmbed-compatible).

heightnumberoptionalHeight in board units.

modestringoptionalEmbed mode: inline | modal.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

preview_urlstringoptionalURL of preview image to display.

widthnumberoptionalWidth in board units.

miro_embed_delete#Deletes an embed item from a Miro board.2 params▾

Deletes an embed item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_embed_get#Retrieves an embed item from a Miro board.2 params▾

Retrieves an embed item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_embed_update#Updates an existing embed item on a Miro board.10 params▾

Updates an existing embed item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

heightnumberoptionalHeight in board units.

modestringoptionalEmbed mode: inline | modal.

parent_idstringoptionalID of parent frame to nest this item inside.

position_xnumberoptionalX coordinate on the board.

position_ynumberoptionalY coordinate on the board.

preview_urlstringoptionalURL of preview image to display.

urlstringoptionalNew embed URL.

widthnumberoptionalWidth in board units.

miro_frame_create#Creates a frame item on a Miro board. Frames group and organize other board items.7 params▾

Creates a frame item on a Miro board. Frames group and organize other board items.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

fill_colorstringoptionalBackground fill color as hex code (e.g. #ffffffff for transparent).

heightnumberoptionalHeight of the frame in board units.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

titlestringoptionalTitle displayed at the top of the frame.

widthnumberoptionalWidth of the frame in board units.

miro_frame_delete#Deletes a frame item from a Miro board.2 params▾

Deletes a frame item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the frame to delete.

miro_frame_get#Retrieves details of a specific frame item on a Miro board.2 params▾

Retrieves details of a specific frame item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the frame item.

miro_frame_update#Updates the title, style, or position of a frame on a Miro board.8 params▾

Updates the title, style, or position of a frame on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the frame to update.

fill_colorstringoptionalUpdated background fill color as hex code.

heightnumberoptionalUpdated height in board units.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

titlestringoptionalUpdated frame title.

widthnumberoptionalUpdated width in board units.

miro_group_create#Creates a group of items on a Miro board. Items in a group move together.2 params▾

Creates a group of items on a Miro board. Items in a group move together.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idsstringrequiredJSON array of item IDs to group, e.g. ["id1","id2"]

miro_group_delete#Deletes a group from a Miro board (items remain but are ungrouped).2 params▾

Deletes a group from a Miro board (items remain but are ungrouped).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

group_idstringrequiredUnique identifier of the group.

miro_group_items_get#Retrieves a group and its items from a Miro board.2 params▾

Retrieves a group and its items from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

group_idstringrequiredUnique identifier of the group.

miro_groups_list#Lists all item groups on a Miro board.2 params▾

Lists all item groups on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

cursorstringoptionalPagination cursor from previous response.

miro_image_create#Creates an image item on a Miro board from a publicly accessible URL.9 params▾

Creates an image item on a Miro board from a publicly accessible URL.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

urlstringrequiredPublicly accessible URL of the image.

heightnumberoptionalHeight of the image in board units.

parent_idstringoptionalID of a parent frame to place the image inside.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

rotationnumberoptionalRotation angle in degrees.

titlestringoptionalDisplay name/title for the image item.

widthnumberoptionalWidth of the image in board units.

miro_image_delete#Deletes an image item from a Miro board.2 params▾

Deletes an image item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the image item to delete.

miro_image_get#Retrieves details of a specific image item on a Miro board.2 params▾

Retrieves details of a specific image item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the image item.

miro_image_update#Updates the URL, title, position, or size of an image item on a Miro board.8 params▾

Updates the URL, title, position, or size of an image item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the image item to update.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

rotationnumberoptionalUpdated rotation angle in degrees.

titlestringoptionalUpdated title for the image.

urlstringoptionalUpdated image URL.

widthnumberoptionalUpdated width in board units.

miro_item_delete#Deletes a specific item from a Miro board.2 params▾

Deletes a specific item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item to delete.

miro_item_get#Retrieves details of a specific item on a Miro board by its item ID.2 params▾

Retrieves details of a specific item on a Miro board by its item ID.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_item_tag_attach#Attaches an existing tag to a specific item on a Miro board.3 params▾

Attaches an existing tag to a specific item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item to attach the tag to.

tag_idstringrequiredUnique identifier of the tag to attach.

miro_item_tag_remove#Removes a tag from a specific item on a Miro board. Does not delete the tag from the board.3 params▾

Removes a tag from a specific item on a Miro board. Does not delete the tag from the board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

tag_idstringrequiredUnique identifier of the tag to remove from the item.

miro_item_tags_get#Returns all tags attached to a specific item on a Miro board.2 params▾

Returns all tags attached to a specific item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_items_bulk_create#Creates up to 20 board items in a single transactional request. Pass a JSON array of item objects as `items`. Each object must have a `type` field (sticky_note, text, shape, card, image, frame, etc.) and appropriate data.2 params▾

Creates up to 20 board items in a single transactional request. Pass a JSON array of item objects as `items`. Each object must have a `type` field (sticky_note, text, shape, card, image, frame, etc.) and appropriate data.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

itemsstringrequiredJSON array of item objects, each with "type" and item-specific fields.

miro_items_list#Returns all items on a Miro board. Optionally filter by item type.1 param▾

Returns all items on a Miro board. Optionally filter by item type.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

miro_mindmap_node_create#Creates a mind map node on a Miro board (experimental API). Omit parent_node_id for the root node.3 params▾

Creates a mind map node on a Miro board (experimental API). Omit parent_node_id for the root node.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

node_valuestringrequiredText content of the mind map node.

parent_node_idstringoptionalID of parent mind map node (omit for root node).

miro_mindmap_node_delete#Deletes a mind map node and all its children from a Miro board (experimental API).2 params▾

Deletes a mind map node and all its children from a Miro board (experimental API).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_mindmap_node_get#Retrieves a specific mind map node from a Miro board (experimental API).2 params▾

Retrieves a specific mind map node from a Miro board (experimental API).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the item.

miro_mindmap_nodes_list#Lists all mind map nodes on a Miro board (experimental API).2 params▾

Lists all mind map nodes on a Miro board (experimental API).

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

cursorstringoptionalPagination cursor from previous response.

miro_oembed_get#Returns oEmbed data for a Miro board URL so it can be embedded as a live iframe in external sites.4 params▾

Returns oEmbed data for a Miro board URL so it can be embedded as a live iframe in external sites.

NameTypeRequiredDescription

urlstringrequiredFull URL of the Miro board.

formatstringoptionalResponse format: json (default) or xml.

maxheightintegeroptionalMaximum embed height in pixels.

maxwidthintegeroptionalMaximum embed width in pixels.

miro_org_get#Retrieves information about the organization (Enterprise only).1 param▾

Retrieves information about the organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

miro_org_member_get#Retrieves a specific member of an organization (Enterprise only).2 params▾

Retrieves a specific member of an organization (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID.

org_idstringrequiredOrganization ID.

miro_org_members_list#Lists all members of an organization (Enterprise only).5 params▾

Lists all members of an organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

cursorstringoptionalPagination cursor.

emailsstringoptionalComma-separated list of emails to filter by.

limitintegeroptionalMax results per page.

rolestringoptionalFilter by role: admin | member.

miro_project_create#Creates a project (space) in a team (Enterprise only).4 params▾

Creates a project (space) in a team (Enterprise only).

NameTypeRequiredDescription

namestringrequiredProject name.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

descriptionstringoptionalProject description.

miro_project_delete#Deletes a project from a team (Enterprise only).3 params▾

Deletes a project from a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

project_idstringrequiredProject ID.

team_idstringrequiredTeam ID.

miro_project_get#Retrieves a specific project (Enterprise only).3 params▾

Retrieves a specific project (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

project_idstringrequiredProject ID.

team_idstringrequiredTeam ID.

miro_project_member_add#Adds a member to a project (Enterprise only).5 params▾

Adds a member to a project (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID to add.

org_idstringrequiredOrganization ID.

project_idstringrequiredProject ID.

team_idstringrequiredTeam ID.

rolestringoptionalRole: editor | commenter | viewer.

miro_project_member_delete#Removes a member from a project (Enterprise only).4 params▾

Removes a member from a project (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID.

org_idstringrequiredOrganization ID.

project_idstringrequiredProject ID.

team_idstringrequiredTeam ID.

miro_project_members_list#Lists members of a project (Enterprise only).5 params▾

Lists members of a project (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

project_idstringrequiredProject ID.

team_idstringrequiredTeam ID.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results.

miro_projects_list#Lists all projects in a team (Enterprise only).4 params▾

Lists all projects in a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results.

miro_shape_create#Creates a shape item on a Miro board. Shapes can contain text and support rich styling.14 params▾

Creates a shape item on a Miro board. Shapes can contain text and support rich styling.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

shapestringrequiredShape type. Valid values: rectangle, round_rectangle, circle, triangle, rhombus, parallelogram, trapezoid, pentagon, hexagon, octagon, star, cross, right_arrow, left_right_arrow, cloud.

contentstringoptionalText content inside the shape (supports simple HTML).

fill_colorstringoptionalBackground fill color as hex code (e.g. #ff0000) or name.

font_sizestringoptionalFont size for text inside the shape as a string number.

heightnumberoptionalHeight of the shape in board units.

parent_idstringoptionalID of a parent frame to place the shape inside.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

rotationnumberoptionalRotation angle in degrees.

stroke_colorstringoptionalBorder/stroke color as hex code.

stroke_widthstringoptionalBorder stroke width as a string number.

text_alignstringoptionalHorizontal text alignment. Valid values: left, center, right.

widthnumberoptionalWidth of the shape in board units.

miro_shape_delete#Deletes a shape item from a Miro board.2 params▾

Deletes a shape item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the shape to delete.

miro_shape_get#Retrieves details of a specific shape item on a Miro board.2 params▾

Retrieves details of a specific shape item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the shape item.

miro_shape_update#Updates the content, style, or position of a shape item on a Miro board.11 params▾

Updates the content, style, or position of a shape item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the shape to update.

contentstringoptionalUpdated text content inside the shape.

fill_colorstringoptionalUpdated fill color as hex code.

heightnumberoptionalUpdated height in board units.

parent_idstringoptionalID of a parent frame to move the shape into.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

shapestringoptionalUpdated shape type (e.g. rectangle, circle, triangle).

stroke_colorstringoptionalUpdated stroke/border color as hex code.

widthnumberoptionalUpdated width in board units.

miro_sticky_note_create#Creates a sticky note item on a Miro board.10 params▾

Creates a sticky note item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

contentstringoptionalText content of the sticky note (supports simple HTML tags).

fill_colorstringoptionalBackground color. Valid values: gray, light_yellow, yellow, orange, light_green, green, dark_green, cyan, light_pink, pink, violet, red, light_blue, blue, dark_blue, black, white.

parent_idstringoptionalID of a parent frame to place the sticky note inside.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

shapestringoptionalShape of the sticky note. Valid values: square, rectangle.

text_alignstringoptionalHorizontal text alignment. Valid values: left, center, right.

text_align_verticalstringoptionalVertical text alignment. Valid values: top, middle, bottom.

widthnumberoptionalWidth of the sticky note in board units.

miro_sticky_note_delete#Deletes a sticky note from a Miro board.2 params▾

Deletes a sticky note from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the sticky note to delete.

miro_sticky_note_get#Retrieves details of a specific sticky note on a Miro board.2 params▾

Retrieves details of a specific sticky note on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the sticky note item.

miro_sticky_note_update#Updates the content, style, or position of a sticky note on a Miro board.10 params▾

Updates the content, style, or position of a sticky note on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the sticky note to update.

contentstringoptionalUpdated text content of the sticky note.

fill_colorstringoptionalUpdated background color (e.g. yellow, blue, pink).

parent_idstringoptionalID of a parent frame to move the sticky note into.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

shapestringoptionalUpdated shape. Valid values: square, rectangle.

text_alignstringoptionalUpdated horizontal text alignment: left, center, right.

widthnumberoptionalUpdated width of the sticky note.

miro_tag_create#Creates a tag on a Miro board. Tags can be attached to items to categorize them.3 params▾

Creates a tag on a Miro board. Tags can be attached to items to categorize them.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

titlestringrequiredTag text (max 120 characters, must be unique on the board).

fill_colorstringoptionalTag color. Valid values: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black.

miro_tag_delete#Deletes a tag from a Miro board. Detaches the tag from all items it was attached to.2 params▾

Deletes a tag from a Miro board. Detaches the tag from all items it was attached to.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

tag_idstringrequiredUnique identifier of the tag to delete.

miro_tag_get#Retrieves details of a specific tag on a Miro board.2 params▾

Retrieves details of a specific tag on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

tag_idstringrequiredUnique identifier of the tag.

miro_tag_update#Updates the title or color of a tag on a Miro board.4 params▾

Updates the title or color of a tag on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

tag_idstringrequiredUnique identifier of the tag to update.

fill_colorstringoptionalUpdated tag color (e.g. red, blue, green, yellow).

titlestringoptionalUpdated tag text (max 120 characters, must be unique on the board).

miro_tags_list#Returns all tags on a Miro board.1 param▾

Returns all tags on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

miro_team_create#Creates a new team in an organization (Enterprise only).3 params▾

Creates a new team in an organization (Enterprise only).

NameTypeRequiredDescription

namestringrequiredTeam name.

org_idstringrequiredOrganization ID.

descriptionstringoptionalTeam description.

miro_team_delete#Deletes a team from an organization (Enterprise only).2 params▾

Deletes a team from an organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_team_get#Retrieves a specific team in an organization (Enterprise only).2 params▾

Retrieves a specific team in an organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_team_member_delete#Removes a member from a team (Enterprise only).3 params▾

Removes a member from a team (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_team_member_get#Retrieves a specific member of a team (Enterprise only).3 params▾

Retrieves a specific member of a team (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_team_member_invite#Invites a user to a team by email (Enterprise only).4 params▾

Invites a user to a team by email (Enterprise only).

NameTypeRequiredDescription

emailstringrequiredUser email.

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

rolestringoptionalRole: admin | member | guest.

miro_team_member_update#Updates the role of a team member (Enterprise only).4 params▾

Updates the role of a team member (Enterprise only).

NameTypeRequiredDescription

member_idstringrequiredMember ID.

org_idstringrequiredOrganization ID.

rolestringrequiredNew role: admin | member | guest.

team_idstringrequiredTeam ID.

miro_team_members_list#Lists members of a team (Enterprise only).4 params▾

Lists members of a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results.

miro_team_settings_get#Retrieves settings for a team (Enterprise only).2 params▾

Retrieves settings for a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

miro_team_settings_update#Updates settings for a team (Enterprise only).4 params▾

Updates settings for a team (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

copy_access_levelstringoptionalWho can copy boards: team_only | company | anyone.

sharing_policystringoptionalBoard sharing policy: team_only | company | public.

miro_team_update#Updates a team's name or description (Enterprise only).4 params▾

Updates a team's name or description (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

team_idstringrequiredTeam ID.

descriptionstringoptionalNew description.

namestringoptionalNew team name.

miro_teams_list#Lists all teams in an organization (Enterprise only).3 params▾

Lists all teams in an organization (Enterprise only).

NameTypeRequiredDescription

org_idstringrequiredOrganization ID.

cursorstringoptionalPagination cursor.

limitintegeroptionalMax results per page.

miro_text_create#Creates a text item on a Miro board.11 params▾

Creates a text item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

contentstringrequiredText content (supports HTML tags).

colorstringoptionalText color as hex code.

fill_colorstringoptionalBackground color as hex code.

font_sizestringoptionalFont size as a string number (e.g. '14').

parent_idstringoptionalID of a parent frame to place the text inside.

position_xnumberoptionalX coordinate on the board (0 = center).

position_ynumberoptionalY coordinate on the board (0 = center).

rotationnumberoptionalRotation angle in degrees.

text_alignstringoptionalText alignment. Valid values: left, center, right.

widthnumberoptionalWidth of the text box in board units.

miro_text_delete#Deletes a text item from a Miro board.2 params▾

Deletes a text item from a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the text item to delete.

miro_text_get#Retrieves details of a specific text item on a Miro board.2 params▾

Retrieves details of a specific text item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the text item.

miro_text_update#Updates the content, style, or position of a text item on a Miro board.8 params▾

Updates the content, style, or position of a text item on a Miro board.

NameTypeRequiredDescription

board_idstringrequiredUnique identifier of the board.

item_idstringrequiredUnique identifier of the text item to update.

colorstringoptionalUpdated text color as hex code.

contentstringoptionalUpdated text content.

font_sizestringoptionalUpdated font size as a string number.

position_xnumberoptionalUpdated X coordinate on the board.

position_ynumberoptionalUpdated Y coordinate on the board.

widthnumberoptionalUpdated width in board units.

miro_token_info_get#Returns information about the current OAuth token including the authenticated user ID, name, team, and granted scopes.0 params▾

Returns information about the current OAuth token including the authenticated user ID, name, team, and granted scopes.