Skip to docs navigation

Miro integration guide

Verified

How to connect Miro to WEXTL and use its 196 actions in your workflows. About Miro: Create and update Miro boards, canvas items, and Enterprise team resources through the Miro REST API.

  • 83 searches
  • 113 actions
  • Polling
  • Auth: OAuth

AI-assisted documentation58 min read

This documentation is compiled from our integration source code, internal specs for Miro, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Miro on WEXTL →
  • Miro
  • WEXTL
  • Google Tasks
  • BigChange
  • Fishbowl Inventory
  • Asset Panda
  • Fieldwire
  • Buildern
  • Basecamp
  • Confluence
  • ClickUp
  • Asana
  • ActiveCollab
  • Autotask PSA
  • Aimsio
  • AroFlo
  • Float
  • DoorLoop
  • Fergus
  • Bonsai
  • FMX
  • BlueFolder
  • Canix
  • Acculynx
  • AgencyZoom
  • Aryeo
  • Aspire
  • FieldPulse
  • 2Solar
  • Businessmap
  • CompanyCam
  • Arcsite

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • Client IDtextRequired

    The Client ID from the settings of your app.[1]

  • Client SecretpasswordRequired

    The Client Secret from the settings of your app. Keep this value confidential.[1]

Integration requests 2 permissions:

  • boards:read
  • boards:write
  1. Log in to your WEXTL account, add the Miro node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Miro account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Get a Board Classification

SearchData classification label on boards.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Board IDRequired
choice
Output fields[3]
FieldType
Label IDtext
Nametext
Colortext
Descriptiontext
Sharing Recommendationtext
Guideline URLurl

1other output field

Get a Board Export Job Status

SearchProgress state of one export job.
Input fields[3]
FieldType
Organization IDRequired
text
Job IDRequired
text
Output fields[3]
FieldType
Job Statustext

Get a Card Item

SearchOne task card with its details.
Input fields[3]
FieldType
Board IDRequired
choice
Card Item IDRequired
text
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Assignee IDtext
Due Datedate
Styleobject
Card Theme (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Get a Case

SearchDetails of one eDiscovery case.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Output fields[3]
FieldType
Case IDtext
Organization IDtext
Nametext
Descriptiontext
Created Byobject
User IDtext
Emailtext
First Nametext
Last Nametext
Last Modified Byobject
User IDtext
Emailtext
First Nametext
Last Nametext

2other output fields

Get a Code Widget Item

SearchA single code snippet with its source text.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Codetext
Languagetext
Line Numbers Visibleboolean
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

4other output fields

Get a Doc Format Item

SearchOne doc item as HTML or Markdown.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Content Formatchoice
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Content Typetext
Contenttext
Content Versiontext
Positionobject
Xnumber
Ynumber
Origintext
Created Atdate
Created Byobject
User IDtext
Typetext

4other output fields

Get a Document Item

SearchOne uploaded or linked document with its metadata.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Document URLurl
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Get a Frame

SearchOne frame with its size and style.
Input fields[3]
FieldType
Board IDRequired
choice
Frame IDRequired
text
Output fields[3]
FieldType
Frame IDtext
Typetext
Dataobject
Titletext
Formattext
Frame Typetext
Show Contentboolean
Styleobject
Fill Colortext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber

2other output fields

Get a Group by Its ID

SearchA set of grouped items.
Input fields[3]
FieldType
Board IDRequired
choice
Group IDRequired
text
Output fields[3]
FieldType
Group IDtext
Typetext
Dataobject
Dataobject
Linksobject
Selfurl

Get a Project

SearchOne team project and its name.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Output fields[3]
FieldType
Project IDtext
Nametext
Typetext

Get a Project Member

SearchOne project member with role and email.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Roletext
Object Typetext

Get a SCIM Group

SearchOne SCIM-managed group with its people.
Input fields[3]
FieldType
SCIM Group IDRequired
text
Output fields[3]
FieldType
SCIM Group IDtext
Display Nametext
Membersarray

Get a SCIM Resource Type

SearchEndpoint details for a resource kind.
Input fields[3]
FieldType
Resource TypeRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Endpointtext
Schema URItext

Get a SCIM Schema

SearchThe attribute list of a single SCIM schema.
Input fields[3]
FieldType
Schema URIRequired
choice
Output fields[3]
FieldType
Schema URItext
Nametext
Descriptiontext
Attributesarray

Get a SCIM User

SearchOne organization member over SCIM.
Input fields[3]
FieldType
SCIM User IDRequired
text
Output fields[3]
FieldType
SCIM User IDtext
Username / Emailtext
Nameobject
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean

1other output field

Get a Shape Item

SearchOne shape with its look and size.
Input fields[3]
FieldType
Board IDRequired
choice
Shape Item IDRequired
text
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Get a Shape Item (Experimental)

SearchExperimental-API lookup of one flowchart shape.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Get a Specific Board

SearchEverything known about a single board.
Input fields[3]
FieldType
Board IDRequired
choice
Output fields[3]
FieldType
Board IDtext
Nametext
Descriptiontext
Typetext
View Linkurl
Created Atdate

10other output fields

Get a Specific Board Member

SearchOne collaborator on a board and their access.
Input fields[3]
FieldType
Board IDRequired
choice
Board Member IDRequired
text
Output fields[3]
FieldType
Board Member IDtext
Nametext
Roletext
Typetext
Linksobject
Selfurl

Get a Specific Connector

SearchOne connector with its endpoints and captions.
Input fields[3]
FieldType
Board IDRequired
choice
Connector IDRequired
text
Output fields[3]
FieldType
Connector IDtext
Typetext
Shapetext
Is Supportedboolean
Start Itemobject
Item IDtext
Positionobject
End Itemobject
Item IDtext
Positionobject

7other output fields

Get a Specific Item on a Board

SearchAny single item on a board, with its parent frame.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parentobject
Parent IDtext

6other output fields

Get a Specific Item on a Board (Experimental)

SearchExperimental-API lookup of any board item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Shapetext
Is Root (mind map node)boolean
Direction (mind map node)text
Node View (mind map node)object
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Get a Specific Mind Map Node

SearchOne mind map node and who it hangs under.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Node Viewobject
Is Rootboolean
Directiontext
Styleobject
Node Border Colortext
Shapetext
Font Sizetext
Created Atdate
Created Byobject
User IDtext
Typetext

4other output fields

Get a Sticky Note Item

SearchOne sticky note with its content and style.
Input fields[3]
FieldType
Board IDRequired
choice
Sticky Note Item IDRequired
text
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Fill Colortext
Text Aligntext
Text Align Verticaltext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Get a Tag

SearchOne board tag with its name and color.
Input fields[3]
FieldType
Board IDRequired
choice
Output fields[3]
FieldType
Tag IDtext
Titletext
Fill Colortext
Typetext
Linksobject
Selftext

Get a Team

SearchOne team with its display name.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Output fields[3]
FieldType
Team IDtext
Nametext
Pictureobject
Picture IDnumber
Image URLurl
Original URLurl
Typetext
Typetext

Get a Team Member

SearchOne team member with role and history.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text
Output fields[3]
FieldType
Team Member IDtext
Team IDtext
Roletext
Typetext
Created Atdate
Created Bytext

2other output fields

Get a Text Item

SearchOne text item with its look and place.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Styleobject
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Get a User Group

SearchName and description of a group.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
Output fields[3]
FieldType
User Group IDtext
Nametext
Descriptiontext
Object Typetext

Get a User Group Member

SearchOne person in a user group, with an address.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
User IDRequired
text
Output fields[3]
FieldType
User IDtext
Emailtext
Object Typetext

Get a User Group of a Team

SearchGroup-to-team link, found from the team.
Input fields[3]
FieldType
Organization IDRequired
text
TeamRequired
choice
User GroupRequired
choice
Output fields[3]
FieldType
User Group IDtext
Roletext
Object Typetext

Get AI Interaction Logs (Beta)

SearchMiro AI events across a date range.
Input fields[3]
FieldType
Organization IDRequired
text
FromRequired
date
ToRequired
date
LimitRequired
number
Session IDsarray
Actor IDsarray

4other input fields

Output fields[3]
FieldType
Log IDtext
Created Atdate
Stored Atdate
Sessionobject
Session IDtext
Surfacetext
Actorobject
IDtext
Typetext
Nametext
Emailtext

6other output fields

Get All Board Members

SearchPeople who can open a board and their roles.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Board Member IDtext
Nametext
Roletext
Typetext

Get All Cases

SearchEvery eDiscovery case in an organization.
Input fields[3]
FieldType
Organization IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
Case IDtext
Organization IDtext
Nametext
Descriptiontext
Created Byobject
User IDtext
Emailtext
First Nametext
Last Nametext
Last Modified Byobject
User IDtext
Emailtext
First Nametext
Last Nametext

2other output fields

Get All Groups on a Board

SearchWhich items are grouped together on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Group IDtext
Typetext
Dataobject
Dataobject
Linksobject
Selfurl

Get All Legal Holds Within a Case

SearchLegal holds attached to a case, with their states.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Legal Hold IDtext
Organization IDtext
Case IDtext
Nametext
Descriptiontext
Statetext

5other output fields

Get an App Card Item

SearchOne app card with its data and style.
Input fields[3]
FieldType
Board IDRequired
choice
App Card Item IDRequired
text
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Statustext
Owned By This Appboolean
Fieldsarray
Styleobject
Fill Color (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Get an Embed Item

SearchOne embed with its link and display.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
URLurl
Modetext
Content Typetext
Titletext
Descriptiontext
HTMLtext
Preview URLurl
Provider Nametext
Provider URLurl
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Get an Image Item

SearchOne picture with its dimensions and look.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Image URLurl
Titletext
Alt Texttext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Get an Organization Member

SearchOne organization member with role and license.
Input fields[3]
FieldType
Organization IDRequired
text
Member IDRequired
text
Output fields[3]
FieldType
Member IDtext
Emailtext
Activeboolean
Roletext
Licensetext
Last Activity Atdate

3other output fields

Get Audit Logs

SearchAudit trail entries within a time window.
Input fields[3]
FieldType
Created AfterRequired
date
Created BeforeRequired
date
LimitRequired
number
Sortingchoice
Output fields[3]
FieldType
Event IDtext
Contextobject
IP Addresstext
Teamobject
Organizationobject
Objectobject
Object IDtext
Object Nametext
Created Atdate
Detailstext
Created Byobject
Typetext
IDtext
Nametext
Emailtext

2other output fields

Get Board Export Jobs

SearchExport jobs filtered by state or creator.
Input fields[3]
FieldType
Organization IDRequired
text
LimitRequired
number
Statustext
Creator IDsarray
Output fields[3]
FieldType
Job IDtext
Nametext
Board Formattext
Statustext
Created Atdate
Modified Atdate

1other output field

Get Board Export Jobs of a Case

SearchExport job IDs tied to one case.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Export Job IDtext

Get Boards

SearchBoards you can access, filtered and sorted.
Input fields[3]
FieldType
Limitnumber
Team IDtext
Project IDtext
Search Querytext
Owner IDtext
Sort Orderchoice
Output fields[3]
FieldType
Board IDtext
Nametext
Descriptiontext
Typetext
View Linkurl
Created Atdate

7other output fields

Get Code Widget Items

SearchAll code snippets found on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Codetext
Languagetext
Line Numbers Visibleboolean
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

4other output fields

Get Connectors

SearchAll connector lines on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Connector IDtext
Typetext
Shapetext
Is Supportedboolean
Start Itemobject
Item IDtext
Positionobject
End Itemobject
Item IDtext
Positionobject

7other output fields

Get Content Change Logs of Board Items

SearchItem change history across boards.
Input fields[3]
FieldType
Organization IDRequired
text
FromRequired
date
ToRequired
date
LimitRequired
number
Board IDsarray
Emailsarray

1other input field

Output fields[3]
FieldType
Content Log IDtext
Board IDtext
Action Typetext
Action Timedate
Actorobject
User IDtext
Emailtext
Nametext
Item Typetext

1other output field

Get Content Items Under a Legal Hold

SearchPreserved content behind one legal hold.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Legal Hold IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
Content IDtext
Typetext

Get Default Team Settings

SearchStarting configuration for teams.
Input fields[3]
FieldType
Organization IDRequired
text
Output fields[3]
FieldType
Organization IDtext
Team IDtext
Account Discovery Settingsobject
Account Discoverytext
Collaboration Settingsobject
Co-Owner Roletext
Copy Access Level Settingsobject
Copy Access Leveltext
Copy Access Level Limitationtext
Invitation Settingsobject
Invite External Userstext
Who Can Invitetext

2other output fields

Get Items by Tag

SearchCards and notes marked with one tag.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Styletext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber

2other output fields

Get Items of a Group by ID

SearchEverything inside one item group.
Input fields[3]
FieldType
Board IDRequired
choice
Group IDRequired
text
Limitnumber
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Parentobject
Parent IDtext

4other output fields

Get Items on Board

SearchEverything on a board, filterable by type.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Item Typechoice
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Slot IDtext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parentobject
Parent IDtext
Linksobject

6other output fields

Get Items on Board (Experimental)

SearchExperimental-API item listing for a board.
Input fields[3]
FieldType
Board IDRequired
choice
Item Typechoice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Shapetext
Is Root (mind map node)boolean
Direction (mind map node)text
Node View (mind map node)object
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Get Items Within a Frame

SearchChild items nested in a frame.
Input fields[3]
FieldType
Board IDRequired
choice
Frame IDRequired
text
Item Type Filterchoice
Limitnumber
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Styletext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber

3other output fields

Get Legal Hold Information

SearchFull record of one legal hold and its status.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Legal Hold IDRequired
text
Output fields[3]
FieldType
Legal Hold IDtext
Organization IDtext
Case IDtext
Nametext
Descriptiontext
Statetext

5other output fields

Get Mind Map Nodes

SearchAll nodes across the mind maps of a board.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Node Viewobject
Is Rootboolean
Directiontext
Styleobject
Node Border Colortext
Shapetext
Font Sizetext
Created Atdate
Created Byobject
User IDtext
Typetext

4other output fields

Get OEmbed Data

SearchEmbed details for a board link.
Input fields[3]
FieldType
Board URLRequired
text
Formatchoice
Max Widthnumber
Max Heightnumber
Output fields[3]
FieldType
Embed HTMLtext
Titletext
Authortext
Versiontext
Typetext
Thumbnail URLtext

4other output fields

Get Organization Info

SearchPlan and license totals of an organization.
Input fields[3]
FieldType
Organization IDRequired
text
Output fields[3]
FieldType
Organization IDtext
Nametext
Plantext
Full Licenses Purchasednumber
Typetext

Get Organization Members

SearchSearchable roster of people and seats.
Input fields[3]
FieldType
Organization IDRequired
text
Limitnumber
Emailstext
Rolechoice
Licensechoice
Active Onlyboolean
Output fields[3]
FieldType
Member IDtext
Emailtext
Activeboolean
Roletext
Licensetext
Last Activity Atdate

3other output fields

Get Organization Settings

SearchBoard classification setup for an organization.
Input fields[3]
FieldType
Organization IDRequired
text
Output fields[3]
FieldType
Typetext
Enabledboolean
Labelsarray

Get Project Settings

SearchSharing rules of a project.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Output fields[3]
FieldType
Sharing Policy Settingsobject
Team Accesstext
Object Typetext

Get Results for a Board Export Job

SearchDownload links of a completed export.
Input fields[3]
FieldType
Organization IDRequired
text
Job IDRequired
text
Output fields[3]
FieldType
Job IDtext
Resultsarray

Get SCIM Service Provider Config

SearchCapabilities of the Miro SCIM service.
Output fields[3]
FieldType
Patch Supportobject
Supportedboolean
Bulk Supportobject
Supportedboolean
Filter Supportobject
Supportedboolean
Max Resultsnumber
Change Password Supportobject
Supportedboolean
Sort Supportobject
Supportedboolean
ETag Supportobject
Supportedboolean

1other output field

Get Tags From a Board

SearchTags available for labeling items on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Tag IDtext
Titletext
Fill Colortext
Typetext

Get Tags From an Item

SearchTags carried by a single board item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Limitnumber
Output fields[3]
FieldType
Tag IDtext
Titletext
Fill Colortext
Typetext

Get Team Classification Settings

SearchDefault labeling settings of one team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Output fields[3]
FieldType
Default Label IDtext
Enabledboolean
Typetext

Get Team Settings

SearchSharing and collaboration rules of a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Output fields[3]
FieldType
Organization IDtext
Team IDtext
Account Discovery Settingsobject
Account Discoverytext
Collaboration Settingsobject
Co-Owner Roletext
Copy Access Level Settingsobject
Copy Access Leveltext
Copy Access Level Limitationtext
Invitation Settingsobject
Invite External Userstext
Who Can Invitetext

2other output fields

Get Teams of a User Group

SearchGroup-to-team memberships and access levels.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
Limitnumber
Output fields[3]
FieldType
Team IDtext
Roletext
Object Typetext

Get the Tasks of a Board Export Job

SearchPer-board work items inside an export job.
Input fields[3]
FieldType
Organization IDRequired
text
Job IDRequired
text
LimitRequired
number
Statustext
Output fields[3]
FieldType
Task IDtext
Statustext
Artifact Expires Atdate
Size (bytes)number
Error Messagetext
Error Typetext

1other output field

Get the Team of a User Group

SearchTeam-side view of where a group belongs.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
TeamRequired
choice
Output fields[3]
FieldType
Team IDtext
Roletext
Object Typetext

Get the User Group Assignments of a Board

SearchGroups with access to one board, by role.
Input fields[3]
FieldType
Organization IDRequired
text
BoardRequired
choice
Limitnumber
Output fields[3]
FieldType
User Group IDtext
Roletext
Object Typetext

Get the User Group Assignments of a Project

SearchGroups holding access on one project.
Input fields[3]
FieldType
Organization IDRequired
text
ProjectRequired
choice
Limitnumber
Output fields[3]
FieldType
User Group IDtext
Roletext
Object Typetext

List Project Members

SearchEveryone with a seat in a project.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Emailtext
Roletext
Object Typetext

List Projects

SearchProjects belonging to a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Object Typetext

List SCIM Groups

SearchGroups managed through SCIM.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
SCIM Group IDtext
Display Nametext
Membersarray

List SCIM Resource Types

SearchResource types available over SCIM.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Endpointtext
Schema URItext

List SCIM Schemas

SearchAll schemas defined for provisioning.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Schema URItext
Nametext
Descriptiontext
Attributesarray

List SCIM Users

SearchOrganization members listed through SCIM.
Input fields[3]
FieldType
Limitnumber
Filtertext
Output fields[3]
FieldType
SCIM User IDtext
Username / Emailtext
Nameobject
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean

1other output field

List Team Members

SearchRoster of a team, filterable by role.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Limitnumber
Rolechoice
Output fields[3]
FieldType
IDtext
Team IDtext
Roletext
Created Atdate
Created Bytext
Modified Atdate

2other output fields

List Teams

SearchTeams in an organization, searchable by name.
Input fields[3]
FieldType
Organization IDRequired
text
Limitnumber
Name Containstext
Output fields[3]
FieldType
IDtext
Nametext
Pictureobject
IDnumber
Image URLtext
Original URLtext
Object Typetext

List User Group Members

SearchPeople enrolled in a user group.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
Limitnumber
Output fields[3]
FieldType
User IDtext
Emailtext
Object Typetext

List User Group to Team Connections

SearchGroups connected to a team, with roles.
Input fields[3]
FieldType
Organization IDRequired
text
TeamRequired
choice
Limitnumber
Output fields[3]
FieldType
User Group IDtext
Roletext
Object Typetext

List User Groups

SearchNames and descriptions of every group.
Input fields[3]
FieldType
Organization IDRequired
text
Limitnumber
Output fields[3]
FieldType
User Group IDtext
Nametext
Descriptiontext
Object Typetext

Add a Member to a Project

ActionGives one user a role level in a project.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
EmailRequired
text
RoleRequired
choice
Output fields[3]
FieldType
IDtext
Emailtext
Roletext
Object Typetext

Add a Member to a User Group

ActionPuts a person into a group.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
EmailRequired
text
Output fields[3]
FieldType
User IDtext
Emailtext
Object Typetext

Attach a Tag to an Item

ActionLabels one board item with a tag.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
Status codenumber

Bulk Edit Membership of a User Group

ActionSeveral group joins and removals at once.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
Members to Addarray
Members to Removearray
Output fields[3]
FieldType
Resultsarray

Bulk Update Boards Classification

ActionSets one classification on many boards.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Label IDRequired
text
Not Classified Onlyboolean
Output fields[3]
FieldType
Number Of Updated Boardsnumber
Typetext

Cancel a Board Export Job

ActionStops an in-progress board export.
Input fields[3]
FieldType
Organization IDRequired
text
Job IDRequired
text
Output fields[3]
FieldType
Statustext

Close a Case

ActionFinishes a case and removes it.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice

Close a Legal Hold

ActionFrees held boards and custodians.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Legal Hold IDRequired
text

Connect a User Group to a Team

ActionGives a group a role in a team.
Input fields[3]
FieldType
Organization IDRequired
text
TeamRequired
choice
User GroupRequired
choice
Output fields[3]
FieldType
User Group IDtext
Roletext
Object Typetext

Copy a Board

ActionClones a board, optionally under a new name and team.
Input fields[3]
FieldType
Board To CopyRequired
choice
Nametext
Descriptiontext
Team IDtext
Sharing Policyobject
Permissions Policyobject
Sharing Access Policyobject
Output fields[3]
FieldType
Board IDtext
Nametext
Descriptiontext
Typetext
View Linkurl
Created Atdate

9other output fields

Create a Board

ActionNew blank board with team, project and sharing options.
Input fields[3]
FieldType
Nametext
Descriptiontext
Team IDtext
Project IDtext
Sharing Policyobject
Permissions Policyobject
Sharing Access Policyobject
Output fields[3]
FieldType
Board IDtext
Nametext
Descriptiontext
Typetext
View Linkurl
Created Atdate

10other output fields

Create a Board Export Job

ActionStarts a bulk board export.
Input fields[3]
FieldType
Organization IDRequired
text
Board IDsRequired
choice
Board Formatchoice
Output fields[3]
FieldType
Job IDtext

Create a Board Group

ActionGroups several board items.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDsRequired
array
Output fields[3]
FieldType
Group IDtext
Typetext
Dataobject
Dataobject
Linksobject
Selfurl

Create a Card Item

ActionCard with an owner and deadline.
Input fields[3]
FieldType
Board IDRequired
choice
Dataobject
Titletext
Descriptiontext
Assignee IDtext
Due Datedate
Styleobject
Card Themetext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parent Frame IDtext
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Assignee IDtext
Due Datedate
Styleobject
Card Theme (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Create a Case

ActionStarts an eDiscovery case.
Input fields[3]
FieldType
Organization IDRequired
text
NameRequired
text
Descriptiontext
Output fields[3]
FieldType
Case IDtext
Organization IDtext
Nametext
Descriptiontext
Created Byobject
User IDtext
Emailtext
First Nametext
Last Nametext
Last Modified Byobject
User IDtext
Emailtext
First Nametext
Last Nametext

2other output fields

Create a Code Widget Item

ActionSyntax-highlighted code block on a board.
Input fields[3]
FieldType
Board IDRequired
choice
CodeRequired
text
Titletext
Languagetext
Show Line Numbersboolean
Parent Frame IDtext

5other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Codetext
Languagetext
Line Numbers Visibleboolean
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

4other output fields

Create a Connector

ActionJoins two board items with a line.
Input fields[3]
FieldType
Board IDRequired
choice
Start Item IDRequired
text
End Item IDRequired
text
Shapechoice
Start Item Positionobject
Xtext
Ytext
Start Item Snap Tochoice

4other input fields

Output fields[3]
FieldType
Connector IDtext
Typetext
Shapetext
Is Supportedboolean
Start Itemobject
Item IDtext
Positionobject
End Itemobject
Item IDtext
Positionobject

7other output fields

Create a Doc Format Item

ActionMarkdown doc item on a board.
Input fields[3]
FieldType
Board IDRequired
choice
ContentRequired
text
Content Versiontext
Parent Frame IDtext
X Positionnumber
Y Positionnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Content Typetext
Contenttext
Content Versiontext
Positionobject
Xnumber
Ynumber
Origintext
Created Atdate
Created Byobject
User IDtext
Typetext

4other output fields

Create a Document Item From a File

ActionUploaded file shown as a board document.
Input fields[3]
FieldType
Board IDRequired
choice
FileRequired
text
Titletext
Parent Frame IDtext
X Positionnumber
Y Positionnumber

3other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Document URLurl
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Widthnumber
Created Atdate

4other output fields

Create a Document Item From a URL

ActionDocument from a web address shown on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Document URLRequired
url
Titletext
Parent Frame IDtext
X Positionnumber
Y Positionnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Document URLurl
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Create a Frame

ActionFrame for organizing a board.
Input fields[3]
FieldType
Board IDRequired
choice
Titletext
Formatchoice
Typechoice
Show Contentboolean
Fill Colortext

6other input fields

Output fields[3]
FieldType
Frame IDtext
Typetext
Dataobject
Titletext
Formattext
Frame Typetext
Show Contentboolean
Styleobject
Fill Colortext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber

3other output fields

Create a Legal Hold

ActionHolds the content of chosen users.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
NameRequired
text
UsersRequired
array
Descriptiontext
Output fields[3]
FieldType
Legal Hold IDtext
Organization IDtext
Case IDtext
Nametext
Descriptiontext
Statetext

5other output fields

Create a Mind Map Node

ActionChild or root node in a board mind map.
Input fields[3]
FieldType
Board IDRequired
choice
Contenttext
Parent Node IDtext
X Positionnumber
Y Positionnumber
Widthnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Node Viewobject
Is Rootboolean
Directiontext
Styleobject
Node Border Colortext
Shapetext
Font Sizetext
Created Atdate
Created Byobject
User IDtext
Typetext

4other output fields

Create a Project

ActionA Space for related boards.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
NameRequired
text
Output fields[3]
FieldType
Project IDtext
Nametext
Typetext

Create a SCIM Group

ActionUser group created over SCIM.
Input fields[3]
FieldType
Display NameRequired
text
Initial Member User IDsarray
Output fields[3]
FieldType
SCIM Group IDtext
Display Nametext
Membersarray

Create a SCIM User

ActionSCIM-provisioned user account with profile data.
Input fields[3]
FieldType
Username / EmailRequired
text
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean
Output fields[3]
FieldType
SCIM User IDtext
Username / Emailtext
Nameobject
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean

1other output field

Create a Shape Item

ActionColored shape with text on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Dataobject
Contenttext
Shapechoice
Styleobject
Fill Colortext
Text Colortext
Fill Opacitytext
Border Colortext
Border Opacitytext
Border Stylechoice
Border Widthtext
Font Sizetext
Font Familychoice
Text Alignchoice
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parent Frame IDtext
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Create a Shape Item (Experimental)

ActionFlowchart-capable shape via the experimental API.
Input fields[3]
FieldType
Board IDRequired
choice
Shapechoice
Contenttext
Parent Frame IDtext
X Positionnumber
Y Positionnumber

14other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Create a Sticky Note Item

ActionColored sticky note posted on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Dataobject
Contenttext
Shapechoice
Styleobject
Fill Colorchoice
Text Alignchoice
Text Align Verticalchoice
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Parent Frame IDtext
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Fill Colortext
Text Aligntext
Text Align Verticaltext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Create a Tag

ActionColor-coded board tag.
Input fields[3]
FieldType
Board IDRequired
choice
TitleRequired
text
Fill Colorchoice
Output fields[3]
FieldType
Tag IDtext
Titletext
Fill Colortext
Typetext
Linksobject
Selftext

Create a Task Export Link

ActionDownload address for one task result.
Input fields[3]
FieldType
Organization IDRequired
text
Job IDRequired
text
Task IDRequired
text
Output fields[3]
FieldType
Statustext
Export Linktext
Artifact Expires Atdate
Link Expires Atdate

Create a Team

ActionNew team for boards and projects.
Input fields[3]
FieldType
Organization IDRequired
text
NameRequired
text
Output fields[3]
FieldType
Team IDtext
Nametext
Pictureobject
Picture IDnumber
Image URLurl
Original URLurl
Typetext
Typetext

Create a Text Item

ActionFree-standing text on a board.
Input fields[3]
FieldType
Board IDRequired
choice
ContentRequired
text
Parent Frame IDtext
X Positionnumber
Y Positionnumber
Widthnumber

7other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Styleobject
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Create a User Group

ActionAccess group of people in an organization.
Input fields[3]
FieldType
Organization IDRequired
text
NameRequired
text
Descriptiontext
Output fields[3]
FieldType
User Group IDtext
Nametext
Descriptiontext
Object Typetext

Create an App Card Item

ActionApp card with a connection status badge.
Input fields[3]
FieldType
Board IDRequired
choice
Dataobject
Titletext
Descriptiontext
Statuschoice
Fieldsarray
Styleobject
Fill Colortext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parent Frame IDtext
Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Statustext
Owned By This Appboolean
Fieldsarray
Styleobject
Fill Color (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Create an Embed Item

ActionExternal content embedded in a board.
Input fields[3]
FieldType
Board IDRequired
choice
URLRequired
url
Display Modechoice
Preview Image URLurl
Parent Frame IDtext
X Positionnumber

3other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
URLurl
Modetext
Content Typetext
Titletext
Descriptiontext
HTMLtext
Preview URLurl
Provider Nametext
Provider URLurl
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Create an Image Item From a File

ActionUploaded image file placed on a board.
Input fields[3]
FieldType
Board IDRequired
choice
FileRequired
text
Titletext
Alt Texttext
Parent Frame IDtext
X Positionnumber

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Image URLurl
Titletext
Alt Texttext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Widthnumber
Created Atdate

4other output fields

Create an Image Item From a URL

ActionOnline image shown on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Image URLRequired
url
Titletext
Alt Texttext
Parent Frame IDtext
X Positionnumber

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Image URLurl
Titletext
Alt Texttext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Create Items in Bulk

ActionBatch creation of mixed board items.
Input fields[3]
FieldType
Board IDRequired
choice
ItemsRequired
array
Output fields[3]
FieldType
Typetext
Created Itemsarray

Create Items in Bulk From Files

ActionBatch of uploaded files turned into board items.
Input fields[3]
FieldType
Board IDRequired
choice
FilesRequired
array
Item Metadata (JSON)Required
text
Output fields[3]
FieldType
Typetext
Created Itemsarray

Delete a Board

ActionDeletes a whole board and its content.
Input fields[3]
FieldType
Board IDRequired
choice

Delete a Card Item

ActionRemoves one task-style card.
Input fields[3]
FieldType
Board IDRequired
choice
Card Item IDRequired
text

Delete a Code Widget Item

ActionDeletes a snippet from the experimental API.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a Connector

ActionRemoves the link drawn between two items.
Input fields[3]
FieldType
Board IDRequired
choice
Connector IDRequired
text

Delete a Doc Format Item

ActionRemoves a formatted doc item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a Document Item

ActionClears a document file item away.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a Frame

ActionDeletes one frame container on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Frame IDRequired
text
Output fields[3]
FieldType
Status codenumber

Delete a Group of Items

ActionDissolves a group, deleting its items on request.
Input fields[3]
FieldType
Board IDRequired
choice
Group IDRequired
text
Delete Items In GroupRequired
boolean

Delete a Mind Map Node

ActionRemoves a mind map branch, children included.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a Project

ActionDeletes a Space owned by a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice

Delete a SCIM Group

ActionRemoves a group managed through SCIM.
Input fields[3]
FieldType
SCIM Group IDRequired
text

Delete a SCIM User

ActionAccount removal through SCIM.
Input fields[3]
FieldType
SCIM User IDRequired
text

Delete a Shape Item

ActionRemoves one drawn shape on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Shape Item IDRequired
text

Delete a Shape Item (Experimental)

ActionExperimental-API deletion of a shape.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a Sticky Note Item

ActionThrows away a sticky note.
Input fields[3]
FieldType
Board IDRequired
choice
Sticky Note Item IDRequired
text

Delete a Tag

ActionDeletes a tag and detaches it everywhere.
Input fields[3]
FieldType
Board IDRequired
choice
Output fields[3]
FieldType
Status codenumber

Delete a Team

ActionDeletes a whole team and its place in the organization.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice

Delete a Text Item

ActionDeletes a text block from a board.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete a User Group

ActionRemoves an organization group and memberships.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice

Delete an App Card Item

ActionClears one app card from a board.
Input fields[3]
FieldType
Board IDRequired
choice
App Card Item IDRequired
text

Delete an Embed Item

ActionDeletes an embedded video or page from a board.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete an Image Item

ActionRemoves a picture item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete an Item

ActionType-agnostic removal of a board item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Delete an Item (Experimental)

ActionExperimental-API variant of item deletion.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text

Disconnect a User Group From a Team

ActionBreaks the tie of a group with a team.
Input fields[3]
FieldType
Organization IDRequired
text
TeamRequired
choice
User GroupRequired
choice

Edit a Case

ActionRewrites the title and summary of a case.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Nametext
Descriptiontext
Output fields[3]
FieldType
Case IDtext
Organization IDtext
Nametext
Descriptiontext
Created Byobject
User IDtext
Emailtext
First Nametext
Last Nametext
Last Modified Byobject
User IDtext
Emailtext
First Nametext
Last Nametext

2other output fields

Edit a Legal Hold

ActionReplaces the user list of a legal hold.
Input fields[3]
FieldType
Organization IDRequired
text
Case IDRequired
choice
Legal Hold IDRequired
text
UsersRequired
array
Nametext
Descriptiontext
Output fields[3]
FieldType
Legal Hold IDtext
Organization IDtext
Case IDtext
Nametext
Descriptiontext
Statetext

5other output fields

Invite Team Members

ActionBrings an organization member into a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
EmailRequired
text
Rolechoice
Output fields[3]
FieldType
Team Member IDtext
Team IDtext
Roletext
Created Atdate
Created Bytext
Modified Atdate

2other output fields

Make an API Call

universalFree-form Miro REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Move a Code Widget Item

ActionRelocates a code snippet around the canvas.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
X Positionnumber
Y Positionnumber
Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Codetext
Languagetext
Line Numbers Visibleboolean
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

4other output fields

Patch a SCIM Group

ActionSelective edits to a SCIM group.
Input fields[3]
FieldType
SCIM Group IDRequired
text
OperationsRequired
array
Output fields[3]
FieldType
SCIM Group IDtext
Display Nametext
Membersarray

Patch a SCIM User

ActionSelective edits to one SCIM user.
Input fields[3]
FieldType
SCIM User IDRequired
text
OperationsRequired
array
Output fields[3]
FieldType
SCIM User IDtext
Username / Emailtext
Nameobject
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean

1other output field

Remove a Board Member

ActionRevokes collaborator access to a board.
Input fields[3]
FieldType
Board IDRequired
choice
Board Member IDRequired
text

Remove a Member From a Team

ActionRevokes a team membership.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text

Remove a Member From a User Group

ActionRevokes a place in a user group.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
User IDRequired
text

Remove a Project Member

ActionEnds a project membership.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text

Remove a Tag From an Item

ActionUnlinks one board tag from an item.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Output fields[3]
FieldType
Status codenumber

Remove a User Group From a Board

ActionRevokes group access to a board.
Input fields[3]
FieldType
Organization IDRequired
text
BoardRequired
choice
User GroupRequired
choice

Remove a User Group From a Project

ActionCancels a group project share.
Input fields[3]
FieldType
Organization IDRequired
text
ProjectRequired
choice
User GroupRequired
choice

Replace a SCIM User

ActionFull profile replacement of a SCIM user.
Input fields[3]
FieldType
SCIM User IDRequired
text
Username / EmailRequired
text
First Nametext
Last Nametext
Display Nametext
License Typetext

1other input field

Output fields[3]
FieldType
SCIM User IDtext
Username / Emailtext
Nameobject
First Nametext
Last Nametext
Display Nametext
License Typetext
Activeboolean

1other output field

Reset All Sessions of a User

ActionEnds every active login of one user.
Input fields[3]
FieldType
EmailRequired
text

Share a Board

ActionEmails an invitation to open a board.
Input fields[3]
FieldType
Board IDRequired
choice
EmailsRequired
array
Rolechoice
Messagetext
Output fields[3]
FieldType
Successful Invitesarray
Failed Invitesarray

Share a Board With User Groups

ActionGrants whole groups access to one board.
Input fields[3]
FieldType
Organization IDRequired
text
BoardRequired
choice
User GroupsRequired
choice
RoleRequired
choice
Output fields[3]
FieldType
Resultsarray

Share a Project With User Groups

ActionGives groups a role in a project.
Input fields[3]
FieldType
Organization IDRequired
text
ProjectRequired
choice
User GroupsRequired
choice
RoleRequired
choice
Output fields[3]
FieldType
Resultsarray

Ungroup Items

ActionDissolves a group and optionally its items.
Input fields[3]
FieldType
Board IDRequired
choice
Group IDRequired
text
Also Delete Itemsboolean

Update a Board

ActionEdits the name, home or sharing of a board.
Input fields[3]
FieldType
Board IDRequired
choice
Nametext
Descriptiontext
Team IDtext
Project IDtext
Sharing Policyobject
Permissions Policyobject
Sharing Access Policyobject
Output fields[3]
FieldType
Board IDtext
Nametext
Descriptiontext
Typetext
View Linkurl
Created Atdate

10other output fields

Update a Board Classification

ActionSets the classification label of one board.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Board IDRequired
choice
Label IDRequired
text
Output fields[3]
FieldType
Label IDtext
Nametext
Colortext
Descriptiontext
Sharing Recommendationtext
Guideline URLurl

1other output field

Update a Board Member

ActionChanges a collaborator role level on a board.
Input fields[3]
FieldType
Board IDRequired
choice
Board Member IDRequired
text
RoleRequired
choice
Output fields[3]
FieldType
Board Member IDtext
Nametext
Roletext
Typetext
Linksobject
Selfurl

Update a Card Item

ActionEdits the text, owner or deadline of a card.
Input fields[3]
FieldType
Board IDRequired
choice
Card Item IDRequired
text
Dataobject
Titletext
Descriptiontext
Assignee IDtext
Due Datedate
Styleobject
Card Themetext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

1other input field

Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Assignee IDtext
Due Datedate
Styleobject
Card Theme (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Update a Code Widget Item

ActionEdits the source or look of a code snippet.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Codetext
Titletext
Languagetext
Show Line Numbersboolean

6other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Codetext
Languagetext
Line Numbers Visibleboolean
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

4other output fields

Update a Connector

ActionChanges endpoints, route or labels of a connector.
Input fields[3]
FieldType
Board IDRequired
choice
Connector IDRequired
text
Start Item IDtext
End Item IDtext
Shapechoice
Start Item Positionobject
Xtext
Ytext

5other input fields

Output fields[3]
FieldType
Connector IDtext
Typetext
Shapetext
Is Supportedboolean
Start Itemobject
Item IDtext
Positionobject
End Itemobject
Item IDtext
Positionobject

7other output fields

Update a Document Item From a File

ActionSwaps a board document for a newly uploaded file.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
FileRequired
text
Titletext
Parent Frame IDtext
X Positionnumber

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Document URLurl
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Widthnumber
Created Atdate

4other output fields

Update a Document Item From a URL

ActionRe-links a board document to another web address.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Document URLurl
Titletext
Parent Frame IDtext
X Positionnumber

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Document URLurl
Titletext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Update a Frame

ActionRenames, recolors or resizes a frame.
Input fields[3]
FieldType
Board IDRequired
choice
Frame IDRequired
text
Titletext
Formatchoice
Typechoice
Show Contentboolean

7other input fields

Output fields[3]
FieldType
Frame IDtext
Typetext
Dataobject
Titletext
Formattext
Frame Typetext
Show Contentboolean
Styleobject
Fill Colortext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber

1other output field

Update a Group With New Items

ActionRedefines which items make up a group.
Input fields[3]
FieldType
Board IDRequired
choice
Group IDRequired
text
Item IDsRequired
array
Output fields[3]
FieldType
Group IDtext
Typetext
Dataobject
Dataobject
Linksobject
Selfurl

Update a Project

ActionRenames a team project.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
NameRequired
text
Output fields[3]
FieldType
Project IDtext
Nametext
Typetext

Update a Project Member

ActionChanges access level inside a project.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text
RoleRequired
choice
Output fields[3]
FieldType
IDtext
Emailtext
Roletext
Object Typetext

Update a Shape Item

ActionEdits the style, text or size of a shape.
Input fields[3]
FieldType
Board IDRequired
choice
Shape Item IDRequired
text
Dataobject
Contenttext
Shapechoice
Styleobject
Fill Colortext
Text Colortext
Fill Opacitytext
Border Colortext
Border Opacitytext
Border Stylechoice
Border Widthtext
Font Sizetext
Font Familychoice
Text Alignchoice
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

1other input field

Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Update a Shape Item (Experimental)

ActionExperimental-API edit of a flowchart shape.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Shapechoice
Contenttext
Parent Frame IDtext
X Positionnumber

15other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Border Colortext
Border Opacitytext
Border Styletext
Border Widthtext
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Update a Sticky Note Item

ActionEdits the text or color of a sticky note.
Input fields[3]
FieldType
Board IDRequired
choice
Sticky Note Item IDRequired
text
Dataobject
Contenttext
Shapechoice
Styleobject
Fill Colorchoice
Text Alignchoice
Text Align Verticalchoice
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber

1other input field

Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Contenttext
Shapetext
Styleobject
Fill Colortext
Text Aligntext
Text Align Verticaltext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Update a Tag

ActionEdits the name or color of a tag.
Input fields[3]
FieldType
Board IDRequired
choice
Titletext
Fill Colorchoice
Output fields[3]
FieldType
Tag IDtext
Titletext
Fill Colortext
Typetext
Linksobject
Selftext

Update a Team

ActionChanges the display name of a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
NameRequired
text
Output fields[3]
FieldType
Team IDtext
Nametext
Pictureobject
Picture IDnumber
Image URLurl
Original URLurl
Typetext
Typetext

Update a Team Member

ActionPromotes or demotes a team member.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Member IDRequired
text
RoleRequired
choice
Output fields[3]
FieldType
Team Member IDtext
Team IDtext
Roletext
Created Atdate
Created Bytext
Modified Atdate

2other output fields

Update a Text Item

ActionEdits the wording or typography of a text block.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Contenttext
Parent Frame IDtext
X Positionnumber
Y Positionnumber

8other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Contenttext
Styleobject
Text Colortext
Fill Colortext
Fill Opacitytext
Font Familytext
Font Sizetext
Text Aligntext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber

6other output fields

Update a User Group

ActionChanges the name or notes of a user group.
Input fields[3]
FieldType
Organization IDRequired
text
User GroupRequired
choice
Nametext
Descriptiontext
Output fields[3]
FieldType
User Group IDtext
Nametext
Descriptiontext
Object Typetext

Update an App Card Item

ActionEdits the status or fields of an app card.
Input fields[3]
FieldType
Board IDRequired
choice
App Card Item IDRequired
text
Dataobject
Titletext
Descriptiontext
Statuschoice
Fieldsarray
Styleobject
Fill Colortext
Positionobject
Xnumber
Ynumber
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

1other input field

Output fields[3]
FieldType
Item IDtext
Typetext
Dataobject
Titletext
Descriptiontext
Statustext
Owned By This Appboolean
Fieldsarray
Styleobject
Fill Color (Hex Color)text
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber

6other output fields

Update an Embed Item

ActionEdits the link or display of an embed.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
URLurl
Display Modechoice
Preview Image URLurl
Parent Frame IDtext

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
URLurl
Modetext
Content Typetext
Titletext
Descriptiontext
HTMLtext
Preview URLurl
Provider Nametext
Provider URLurl
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Update an Image Item From a File

ActionReplaces a board image with an uploaded file.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
FileRequired
text
Titletext
Alt Texttext
Parent Frame IDtext

5other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Image URLurl
Titletext
Alt Texttext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Geometryobject
Heightnumber
Widthnumber
Created Atdate

4other output fields

Update an Image Item From a URL

ActionRe-links a board image to another address.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Image URLurl
Titletext
Alt Texttext
Parent Frame IDtext

5other input fields

Output fields[3]
FieldType
IDtext
Typetext
Dataobject
Image URLurl
Titletext
Alt Texttext
Positionobject
Origintext
Relative Totext
Xnumber
Ynumber
Slot IDtext
Geometryobject
Heightnumber
Rotationnumber
Widthnumber
Created Atdate

5other output fields

Update an Item Position or Parent

ActionRelocates an item or moves it into a frame.
Input fields[3]
FieldType
Board IDRequired
choice
Item IDRequired
text
Positionobject
Xnumber
Ynumber
Parent Frame IDtext
Output fields[3]
FieldType
Item IDtext
Typetext
Datatext
Positionobject
Xnumber
Ynumber
Origintext
Relative Totext
Geometryobject
Widthnumber
Heightnumber
Rotationnumber
Parentobject
Parent IDtext

5other output fields

Update Project Settings

ActionSwitches a project between private and team view.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Team Accesschoice
Output fields[3]
FieldType
Sharing Policy Settingsobject
Team Accesstext
Object Typetext

Update Team Classification Settings

ActionSwitches classification and its default label for a team.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Enabledboolean
Default Label IDtext
Output fields[3]
FieldType
Default Label IDtext
Enabledboolean
Typetext

Update Team Settings

ActionEdits discovery, collaboration, copy and sharing rules.
Input fields[3]
FieldType
Organization IDRequired
text
Team IDRequired
choice
Account Discovery Settingsobject
Account Discoverytext
Collaboration Settingsobject
Co-Owner Roletext
Copy Access Level Settingsobject
Copy Access Leveltext
Copy Access Level Limitationtext
Invitation Settingsobject
Invite External Userstext
Who Can Invitetext

1other input field

Output fields[3]
FieldType
Organization IDtext
Team IDtext
Account Discovery Settingsobject
Account Discoverytext
Collaboration Settingsobject
Co-Owner Roletext
Copy Access Level Settingsobject
Copy Access Leveltext
Copy Access Level Limitationtext
Invitation Settingsobject
Invite External Userstext
Who Can Invitetext

2other output fields

Look for Miro templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Miro Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Miro.
  4. WEXTL® visual workflow builder data.

Last updated: Sep 5, 2026 15:33

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.