Create and update Miro boards, canvas items, and Enterprise team resources through the Miro REST API. When Miro work moves, update stakeholders or kick the next automation.
Get a Group by Its IDRetrieves a single item group from a board.
Get AI Interaction Logs (Beta)Retrieves AI interaction logs for your organization over a date range.
Get All Board MembersRetrieves a list of members on a board.
Get All CasesRetrieves the list of eDiscovery cases in an organization.
Get All Groups on a BoardRetrieves a list of all item groups on a board.
Get All Legal Holds Within a CaseRetrieves the list of all legal holds within a case for an organization.
Get App Card ItemRetrieves a single app card item from a board.
Get Audit LogsRetrieves a page of audit events from the last 90 days for your organization.
Get Board ClassificationRetrieves the classification label currently applied to a board.
Get Board Export Jobs ListRetrieves the list of board export jobs based on the filters provided in the request.
Get Board Export Jobs of a CaseRetrieves the board export jobs linked to a case.
Get Board Export Job StatusRetrieves the status of a board export job.
Get Board Export Job Tasks ListRetrieves the list of tasks for a board export job.
Get BoardsRetrieves a list of boards accessible to the connected user.
Get Board User Group AssignmentsRetrieves information about user groups invited to a board.
Get Card ItemRetrieves a single card item from a board.
Get CaseRetrieves information about a case in an organization.
Get Code Widget ItemRetrieves information for a specific code widget item on a board.
Get Code Widget ItemsRetrieves a list of code widget items for a specific board.
Get ConnectorsRetrieves a list of connectors on a board.
Get Content Items Under Legal HoldLists all content items preserved under a specific legal hold in a case for an organization.
Get Default Team SettingsRetrieves the default settings newly created teams inherit within an organization.
Get Doc Format ItemRetrieves information for a specific doc format item on a board.
Get Document ItemRetrieves information for a specific document item on a board.
Get Embed ItemRetrieves information for a specific embed item on a board.
Get FrameRetrieves a single frame from a board by its item ID.
Get GroupRetrieves a single SCIM group (user group) by its ID, including its members.
Get GroupRetrieves a single SCIM group by its ID (legacy team-based SCIM documentation, where a SCIM Group corresponds to a Miro team — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Get Image ItemRetrieves information for a specific image item on a board.
Get Items by TagRetrieves the cards and sticky notes on a board that carry the specified tag.
Get Items of a Group by IDRetrieves the items that belong to a specific item group.
Get Items on BoardRetrieves a list of items on a board, of any supported item type.
Get Items on BoardRetrieves a list of items for a specific board.
Get Items Within FrameRetrieves the items nested inside a specific frame on a board.
Get Legal Hold InformationRetrieves information about a legal hold within a case for an organization.
Get Mind Map NodesRetrieves a list of mind map nodes for a specific board.
Get OEmbed DataRetrieves the information needed to embed a public Miro board as a live embed.
Get Organization InfoRetrieves details about a Miro Enterprise organization.
Get Organization MemberRetrieves a single member of a Miro Enterprise organization by ID.
Get Organization MembersSearches or lists the members of a Miro Enterprise organization.
Get Organization SettingsRetrieves the board-classification settings for a Miro Enterprise organization.
Get ProjectRetrieves a single project (space) by ID.
Get Project MemberRetrieves information about a single member of a project.
Get Project SettingsRetrieves the sharing policy settings for a project.
Get Project User Group AssignmentsRetrieves information about user groups invited to a project.
Get Resource TypeRetrieves metadata for an available SCIM resource type (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Get Resource TypeRetrieves metadata for an available SCIM resource type (User or Group).
Get Results for Board Export JobRetrieves the results of a board export job, including the download link for each board.
Get SchemaRetrieves the attribute definitions for a single SCIM schema URI (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Get SchemaRetrieves the attribute definitions for a single SCIM schema URI.
Get Service Provider ConfigRetrieves the supported SCIM operations and basic API configuration (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Get Service Provider ConfigRetrieves the supported SCIM operations and basic API configuration.
Get Shape ItemRetrieves information for a specific shape item on a board.
Get Shape ItemRetrieves a single shape item from a board.
Get Specific BoardRetrieves information about a specific board.
Get Specific Board MemberRetrieves the role of a specific board member.
Get Specific ConnectorRetrieves a single connector from a board.
Get Specific Item on BoardRetrieves a single item of any type from a board.
Get Specific Item on BoardRetrieves information for a specific item on a board.
Get Specific Mind Map NodeRetrieves information for a specific mind map node on a board.
Get Sticky Note ItemRetrieves a single sticky note item from a board.
Get TagRetrieves a single tag by its ID.
Get Tags from BoardRetrieves the list of tags defined on the specified board.
Get Tags from ItemRetrieves the tags attached to a specific card or sticky note.
Get TeamRetrieves a single team by ID.
Get Team MemberRetrieves a single team member by ID.
Get Team SettingsRetrieves the general settings (discovery, collaboration, copying, invitations, sharing policy) of an existing team.
Get Team SettingsRetrieves the board-classification settings for an existing team.
Get Teams of a User GroupRetrieves the list of teams that a user group is part of.
Get Text ItemRetrieves information for a specific text item on a board.
Get UserRetrieves a single SCIM user by ID (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Get UserRetrieves a single SCIM user by ID. Returns only users who are members of the organization, not guests.
Get User GroupRetrieves a single user group in an organization.
Get User Group MemberRetrieves information about a user group member in an organization.
Get User Group of a TeamRetrieves information about a specific user group of a team.
Get User Group TeamRetrieves information about a specific team that a user group is part of.
List GroupsRetrieves a paginated list of SCIM groups (legacy team-based SCIM documentation, where a SCIM Group corresponds to a Miro team — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
List GroupsRetrieves a paginated list of SCIM groups (user groups) in the organization, including their members.
List of Project MembersRetrieves a list of members belonging to a project.
List of ProjectsRetrieves a list of projects within a team.
List of User Group MembersRetrieves the list of members who are part of a user group in an organization.
List of User GroupsRetrieves a list of user groups in an organization.
List of User Group to Team ConnectionsRetrieves the list of user groups that are part of a team in an organization.
List Resource TypesRetrieves information about which SCIM resource types are supported (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
List Resource TypesRetrieves information about which SCIM resource types are supported (Users and Groups).
List SchemasRetrieves metadata about the User, Group, and enterprise-user extension attribute schemas Miro's SCIM API supports.
List SchemasRetrieves metadata about the User, Group, and enterprise-user extension attribute schemas (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
List Team MembersRetrieves a list of members belonging to a team.
List TeamsRetrieves a list of teams in a Miro organization.
List UsersRetrieves a paginated list of SCIM users who are members of the organization.
List UsersRetrieves a paginated list of SCIM users (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Retrieve Content Change Logs of Board ItemsRetrieves content change logs for board items within your organization over a date range.
Add Member in a ProjectAdds a user as a member of a project.
Attach Tag to ItemAttaches an existing tag to the specified card or sticky note.
Bulk Edit of Membership in User GroupAdds and removes multiple members of a user group in one request.
Bulk Update Boards ClassificationApplies a classification label to every board in a team at once.
Close CasePermanently closes an eDiscovery case in an organization.
Close Legal HoldPermanently closes a legal hold in a case for an organization.
Copy BoardCreates a copy of an existing board.
Create App Card ItemCreates a new app card item on a board.
Create BoardCreates a new board.
Create Board Export JobCreates an export job for one or more boards.
Create Board User Group AssignmentsShares a board with user groups with a specified role, or updates their role if already shared.
Create Card ItemCreates a new card item on a board.
Create CaseCreates a new eDiscovery case in an organization.
Create Code Widget ItemAdds a code widget item to a board.
Create ConnectorCreates a new connector between two items on a board.
Create Doc Format ItemAdds a doc format item to a board.
Create Document Item Using File from DeviceAdds a document item to a board by uploading a file from your device.
Create Document Item Using URLAdds a document item to a board by specifying the URL where the document is hosted.
Create Embed ItemAdds an embed item containing external content to a board.
Create FrameCreates a new frame on the specified board.
Create GroupGroups a set of items together on a board.
Create GroupCreates a new SCIM group (user group) in the organization, optionally with initial members.
Create Image Item Using File from DeviceAdds an image item to a board by uploading a file from your device.
Create Image Item Using URLAdds an image item to a board by specifying an image URL.
Create Items in BulkCreates up to 20 items of different types on a board in a single request.
Create Items in Bulk Using File from DeviceUploads one or more files and creates document items from them on a board.
Create Legal HoldCreates a new legal hold in a case for an organization, placing the listed users' content under hold.
Create Mind Map NodeAdds a mind map node to a board.
Create ProjectCreates a new project (space) within a team.
Create Project User Group AssignmentsShares a project with user groups with a specified role, or updates their role if already shared.
Create Shape ItemCreates a new shape item on a board.
Create Shape ItemAdds a flowchart shape item to a board.
Create Sticky Note ItemCreates a new sticky note item on a board.
Create TagCreates a new tag on the specified board.
Create Task Export LinkCreates a link to download the results of a board export task.
Create TeamCreates a new team within a Miro Enterprise organization.
Create Text ItemAdds a text item to a board.
Create UserCreates a new user in the organization via SCIM (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Create UserCreates a new user in the organization via SCIM. All newly provisioned users are added to the default team.
Create User GroupCreates a new user group in an organization.
Create User Group MemberAdds a member to a user group in an organization.
Create User Group to Team ConnectionAdds a user group to a team in an organization.
Delete App Card ItemDeletes an app card item from a board.
Delete BoardDeletes an existing board.
Delete Board User Group AssignmentRemoves a user group from a board.
Delete Card ItemDeletes a card item from a board.
Delete Code Widget ItemDeletes a code widget item from the board.
Delete ConnectorDeletes a connector from a board.
Delete Doc Format ItemDeletes a doc format item from the board.
Delete Document ItemDeletes a document item from the board.
Delete Embed ItemDeletes an embed item from the board.
Delete FrameDeletes the specified frame from a board.
Delete GroupDeletes a single group (user group) from the organization via SCIM.
Delete Image ItemDeletes an image item from the board.
Delete ItemDeletes an item of any type from a board.
Delete ItemDeletes an item from a board.
Delete Mind Map NodeDeletes a mind map node item and its child nodes from the board.
Delete ProjectDeletes an existing project from a team.
Delete Project User Group AssignmentRemoves a user group from a project.
Delete Shape ItemDeletes a shape item from a board.
Delete Shape ItemDeletes a flowchart shape item from the board.
Deletes the GroupDeletes a group and optionally the items inside it.
Delete Sticky Note ItemDeletes a sticky note item from a board.
Delete TagDeletes the specified tag from a board and every card or sticky note it was attached to.
Delete TeamPermanently deletes a team from a Miro Enterprise organization.
Delete Team Member from TeamRemoves a member from a team.
Delete Text ItemDeletes a text item from the board.
Delete UserDeactivates and removes a user from the organization via SCIM (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Delete UserDeactivates and removes a user from the organization via SCIM.
Delete User GroupDeletes a user group from an organization.
Delete User Group MemberRemoves a member from a user group in an organization.
Delete User Group to Team ConnectionRemoves a user group from a team in an organization.
Edit CaseUpdates the name or description of an existing case.
Edit Legal HoldUpdates the name, description, or held users and boards of an existing legal hold.
Invite Team MembersInvites an existing organization member to join a team.
Make an API CallPerforms an arbitrary authorized API call to the Miro REST API.
Move Code Widget ItemUpdates the position of a code widget item on a board.
Patch GroupAdds, removes, or replaces members of a SCIM group, or updates its display name.
Patch GroupAdds, removes, or replaces members of a SCIM group, or updates its display name (legacy team-based SCIM documentation, where a SCIM Group corresponds to a Miro team — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Patch UserUpdates a user's status, name, username, role, or license using SCIM patch operations (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Patch UserUpdates a user's status, name, username, role, or license using SCIM patch operations.
Remove Board MemberRemoves a member from a board.
Remove Project MemberRemoves a member from a project.
Remove Tag from ItemRemoves the specified tag from an item while leaving the tag defined on the board.
Replace UserOverwrites a user's SCIM profile with the values provided, replacing every attribute at once.
Replace UserOverwrites a user's SCIM profile with the values provided (legacy team-based SCIM documentation — Miro serves the identical request either way; which behavior applies depends on whether your organization has migrated to user-group-based SCIM sync, not on which of these two modules you use).
Reset All Sessions of a UserEnds every active Miro session across devices for a user, requiring them to sign in again.
Share BoardInvites one or more people to a board by email.
Ungroup ItemsDissolves a group, optionally deleting its items too.
Update App Card ItemUpdates an existing app card item on a board.
Update BoardUpdates the name, description, or sharing policy of an existing board.
Update Board ClassificationApplies a classification label to a board.
Update Board Export Job StatusCancels an ongoing board export job.
Update Board MemberUpdates the role of a board member.
Update Card ItemUpdates an existing card item on a board.
Update Code Widget ItemUpdates a code widget item on a board based on the data properties provided in the request body.
Update ConnectorUpdates an existing connector on a board.
Update Document Item Using File from DeviceUpdates a document item on a board by uploading a replacement file from your device.
Update Document Item Using URLUpdates a document item on a board.
Update Embed ItemUpdates an embed item on a board based on the data properties provided in the request body.
Update FrameUpdates the properties of an existing frame on a board.
Update Image Item Using File from DeviceUpdates an image item on a board by uploading a replacement file from your device.
Update Image Item Using URLUpdates an image item on a board.
Update Item Position or ParentUpdates the position or parent frame of an item, regardless of its type.
Update ProjectUpdates the name of an existing project (space).
Update Project MemberUpdates the role of an existing project member.
Update Project SettingsUpdates the sharing policy settings for a project.
Updates a Group with New ItemsReplaces the set of items in an existing group.
Update Shape ItemUpdates an existing shape item on a board.
Update Shape ItemUpdates a flowchart shape item on a board based on the data and style properties provided in the request body.
Update Sticky Note ItemUpdates an existing sticky note item on a board.
Update TagUpdates the properties of an existing tag on a board.
Update TeamUpdates the name of an existing team.
Update Team MemberUpdates the role of an existing team member.
Update Team SettingsUpdates one or more general settings groups (discovery, collaboration, copying, invitations, sharing policy) of an existing team.
Update Team SettingsUpdates the board-classification default label and enablement for an existing team.
Update Text ItemUpdates a text item on a board based on the data and style properties provided in the request body.
Update User GroupUpdates a user group in an organization.
When to use Miro
Common scenarios where Miro automation saves time and reduces manual work.
Automate "Get a Group by Its ID" in Miro as a workflow step — combine it with triggers, filters, and AI steps for full-pipeline coverage.
Run "Get AI Interaction Logs (Beta)" in Miro from any upstream event — map fields once and let the automation handle the rest.
Layer "Get All Board Members" from Miro with filters, transforms, and AI steps to build automations that match your exact business logic.
Frequently asked questions
Common questions about automating Miro in your workflows.
Miro has no triggers, but it provides 210 actions including "Get a Group by Its ID", "Get AI Interaction Logs (Beta)", and "Get All Board Members". Pair them with triggers from other apps to automate Miro tasks.
Connect Miro to any app in workflows
Search apps and open an app-to-app integration page in one click.