Miro integration guide
VerifiedHow 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].
Requirements
Get your Miro credentials
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:readboards:write
Connect Miro in WEXTL
- Log in to your WEXTL account, add the Miro node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Miro account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Miro triggers and actions on WEXTL
The list below is a reference of every Miro node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Miro node module below opens to reveal its input parameters, outputs, and connection requirements.
Get a Board Classification
SearchData classification label on boards.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Board IDRequired | choice |
| Field | Type |
|---|---|
| Label ID | text |
| Name | text |
| Color | text |
| Description | text |
| Sharing Recommendation | text |
| Guideline URL | url |
1other output field
Get a Board Export Job Status
SearchProgress state of one export job.
| Field | Type |
|---|---|
Organization IDRequired | text |
Job IDRequired | text |
| Field | Type |
|---|---|
| Job Status | text |
Get a Card Item
SearchOne task card with its details.
| Field | Type |
|---|---|
Board IDRequired | choice |
Card Item IDRequired | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Assignee ID | text |
| Due Date | date |
| Style | object |
| Card Theme (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Get a Case
SearchDetails of one eDiscovery case.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
| Field | Type |
|---|---|
| Case ID | text |
| Organization ID | text |
| Name | text |
| Description | text |
| Created By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Last Modified By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
2other output fields
Get a Code Widget Item
SearchA single code snippet with its source text.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Code | text |
| Language | text |
| Line Numbers Visible | boolean |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
4other output fields
Get a Doc Format Item
SearchOne doc item as HTML or Markdown.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Content Format | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content Type | text |
| Content | text |
| Content Version | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Created At | date |
| Created By | object |
| User ID | text |
| Type | text |
4other output fields
Get a Document Item
SearchOne uploaded or linked document with its metadata.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Document URL | url |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Get a Frame
SearchOne frame with its size and style.
| Field | Type |
|---|---|
Board IDRequired | choice |
Frame IDRequired | text |
| Field | Type |
|---|---|
| Frame ID | text |
| Type | text |
| Data | object |
| Title | text |
| Format | text |
| Frame Type | text |
| Show Content | boolean |
| Style | object |
| Fill Color | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
2other output fields
Get a Group by Its ID
SearchA set of grouped items.
| Field | Type |
|---|---|
Board IDRequired | choice |
Group IDRequired | text |
| Field | Type |
|---|---|
| Group ID | text |
| Type | text |
| Data | object |
| Data | object |
| Links | object |
| Self | url |
Get a Project
SearchOne team project and its name.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Field | Type |
|---|---|
| Project ID | text |
| Name | text |
| Type | text |
Get a Project Member
SearchOne project member with role and email.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Role | text |
| Object Type | text |
Get a SCIM Group
SearchOne SCIM-managed group with its people.
| Field | Type |
|---|---|
SCIM Group IDRequired | text |
| Field | Type |
|---|---|
| SCIM Group ID | text |
| Display Name | text |
| Members | array |
Get a SCIM Resource Type
SearchEndpoint details for a resource kind.
| Field | Type |
|---|---|
Resource TypeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Endpoint | text |
| Schema URI | text |
Get a SCIM Schema
SearchThe attribute list of a single SCIM schema.
| Field | Type |
|---|---|
Schema URIRequired | choice |
| Field | Type |
|---|---|
| Schema URI | text |
| Name | text |
| Description | text |
| Attributes | array |
Get a SCIM User
SearchOne organization member over SCIM.
| Field | Type |
|---|---|
SCIM User IDRequired | text |
| Field | Type |
|---|---|
| SCIM User ID | text |
| Username / Email | text |
| Name | object |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
1other output field
Get a Shape Item
SearchOne shape with its look and size.
| Field | Type |
|---|---|
Board IDRequired | choice |
Shape Item IDRequired | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Get a Shape Item (Experimental)
SearchExperimental-API lookup of one flowchart shape.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Get a Specific Board
SearchEverything known about a single board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Field | Type |
|---|---|
| Board ID | text |
| Name | text |
| Description | text |
| Type | text |
| View Link | url |
| Created At | date |
10other output fields
Get a Specific Board Member
SearchOne collaborator on a board and their access.
| Field | Type |
|---|---|
Board IDRequired | choice |
Board Member IDRequired | text |
| Field | Type |
|---|---|
| Board Member ID | text |
| Name | text |
| Role | text |
| Type | text |
| Links | object |
| Self | url |
Get a Specific Connector
SearchOne connector with its endpoints and captions.
| Field | Type |
|---|---|
Board IDRequired | choice |
Connector IDRequired | text |
| Field | Type |
|---|---|
| Connector ID | text |
| Type | text |
| Shape | text |
| Is Supported | boolean |
| Start Item | object |
| Item ID | text |
| Position | object |
| End Item | object |
| Item ID | text |
| Position | object |
7other output fields
Get a Specific Item on a Board
SearchAny single item on a board, with its parent frame.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent | object |
| Parent ID | text |
6other output fields
Get a Specific Item on a Board (Experimental)
SearchExperimental-API lookup of any board item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Is Root (mind map node) | boolean |
| Direction (mind map node) | text |
| Node View (mind map node) | object |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Get a Specific Mind Map Node
SearchOne mind map node and who it hangs under.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Node View | object |
| Is Root | boolean |
| Direction | text |
| Style | object |
| Node Border Color | text |
| Shape | text |
| Font Size | text |
| Created At | date |
| Created By | object |
| User ID | text |
| Type | text |
4other output fields
Get a Sticky Note Item
SearchOne sticky note with its content and style.
| Field | Type |
|---|---|
Board IDRequired | choice |
Sticky Note Item IDRequired | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Fill Color | text |
| Text Align | text |
| Text Align Vertical | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Get a Tag
SearchOne board tag with its name and color.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Field | Type |
|---|---|
| Tag ID | text |
| Title | text |
| Fill Color | text |
| Type | text |
| Links | object |
| Self | text |
Get a Team
SearchOne team with its display name.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Field | Type |
|---|---|
| Team ID | text |
| Name | text |
| Picture | object |
| Picture ID | number |
| Image URL | url |
| Original URL | url |
| Type | text |
| Type | text |
Get a Team Member
SearchOne team member with role and history.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
| Field | Type |
|---|---|
| Team Member ID | text |
| Team ID | text |
| Role | text |
| Type | text |
| Created At | date |
| Created By | text |
2other output fields
Get a Text Item
SearchOne text item with its look and place.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Style | object |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Get a User Group
SearchName and description of a group.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
| Field | Type |
|---|---|
| User Group ID | text |
| Name | text |
| Description | text |
| Object Type | text |
Get a User Group Member
SearchOne person in a user group, with an address.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
User IDRequired | text |
| Field | Type |
|---|---|
| User ID | text |
| text | |
| Object Type | text |
Get a User Group of a Team
SearchGroup-to-team link, found from the team.
| Field | Type |
|---|---|
Organization IDRequired | text |
TeamRequired | choice |
User GroupRequired | choice |
| Field | Type |
|---|---|
| User Group ID | text |
| Role | text |
| Object Type | text |
Get AI Interaction Logs (Beta)
SearchMiro AI events across a date range.
| Field | Type |
|---|---|
Organization IDRequired | text |
FromRequired | date |
ToRequired | date |
LimitRequired | number |
| Session IDs | array |
| Actor IDs | array |
4other input fields
| Field | Type |
|---|---|
| Log ID | text |
| Created At | date |
| Stored At | date |
| Session | object |
| Session ID | text |
| Surface | text |
| Actor | object |
| ID | text |
| Type | text |
| Name | text |
| text |
6other output fields
Get All Board Members
SearchPeople who can open a board and their roles.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Board Member ID | text |
| Name | text |
| Role | text |
| Type | text |
Get All Cases
SearchEvery eDiscovery case in an organization.
| Field | Type |
|---|---|
Organization IDRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Case ID | text |
| Organization ID | text |
| Name | text |
| Description | text |
| Created By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Last Modified By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
2other output fields
Get All Groups on a Board
SearchWhich items are grouped together on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Group ID | text |
| Type | text |
| Data | object |
| Data | object |
| Links | object |
| Self | url |
Get All Legal Holds Within a Case
SearchLegal holds attached to a case, with their states.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Legal Hold ID | text |
| Organization ID | text |
| Case ID | text |
| Name | text |
| Description | text |
| State | text |
5other output fields
Get an App Card Item
SearchOne app card with its data and style.
| Field | Type |
|---|---|
Board IDRequired | choice |
App Card Item IDRequired | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Status | text |
| Owned By This App | boolean |
| Fields | array |
| Style | object |
| Fill Color (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Get an Embed Item
SearchOne embed with its link and display.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| URL | url |
| Mode | text |
| Content Type | text |
| Title | text |
| Description | text |
| HTML | text |
| Preview URL | url |
| Provider Name | text |
| Provider URL | url |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Get an Image Item
SearchOne picture with its dimensions and look.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Get an Organization Member
SearchOne organization member with role and license.
| Field | Type |
|---|---|
Organization IDRequired | text |
Member IDRequired | text |
| Field | Type |
|---|---|
| Member ID | text |
| text | |
| Active | boolean |
| Role | text |
| License | text |
| Last Activity At | date |
3other output fields
Get Audit Logs
SearchAudit trail entries within a time window.
| Field | Type |
|---|---|
Created AfterRequired | date |
Created BeforeRequired | date |
LimitRequired | number |
| Sorting | choice |
| Field | Type |
|---|---|
| Event ID | text |
| Context | object |
| IP Address | text |
| Team | object |
| Organization | object |
| Object | object |
| Object ID | text |
| Object Name | text |
| Created At | date |
| Details | text |
| Created By | object |
| Type | text |
| ID | text |
| Name | text |
| text |
2other output fields
Get Board Export Jobs
SearchExport jobs filtered by state or creator.
| Field | Type |
|---|---|
Organization IDRequired | text |
LimitRequired | number |
| Status | text |
| Creator IDs | array |
| Field | Type |
|---|---|
| Job ID | text |
| Name | text |
| Board Format | text |
| Status | text |
| Created At | date |
| Modified At | date |
1other output field
Get Board Export Jobs of a Case
SearchExport job IDs tied to one case.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Export Job ID | text |
Get Boards
SearchBoards you can access, filtered and sorted.
| Field | Type |
|---|---|
| Limit | number |
| Team ID | text |
| Project ID | text |
| Search Query | text |
| Owner ID | text |
| Sort Order | choice |
| Field | Type |
|---|---|
| Board ID | text |
| Name | text |
| Description | text |
| Type | text |
| View Link | url |
| Created At | date |
7other output fields
Get Code Widget Items
SearchAll code snippets found on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Code | text |
| Language | text |
| Line Numbers Visible | boolean |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
4other output fields
Get Connectors
SearchAll connector lines on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Connector ID | text |
| Type | text |
| Shape | text |
| Is Supported | boolean |
| Start Item | object |
| Item ID | text |
| Position | object |
| End Item | object |
| Item ID | text |
| Position | object |
7other output fields
Get Content Change Logs of Board Items
SearchItem change history across boards.
| Field | Type |
|---|---|
Organization IDRequired | text |
FromRequired | date |
ToRequired | date |
LimitRequired | number |
| Board IDs | array |
| Emails | array |
1other input field
| Field | Type |
|---|---|
| Content Log ID | text |
| Board ID | text |
| Action Type | text |
| Action Time | date |
| Actor | object |
| User ID | text |
| text | |
| Name | text |
| Item Type | text |
1other output field
Get Content Items Under a Legal Hold
SearchPreserved content behind one legal hold.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
Legal Hold IDRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Content ID | text |
| Type | text |
Get Default Team Settings
SearchStarting configuration for teams.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Field | Type |
|---|---|
| Organization ID | text |
| Team ID | text |
| Account Discovery Settings | object |
| Account Discovery | text |
| Collaboration Settings | object |
| Co-Owner Role | text |
| Copy Access Level Settings | object |
| Copy Access Level | text |
| Copy Access Level Limitation | text |
| Invitation Settings | object |
| Invite External Users | text |
| Who Can Invite | text |
2other output fields
Get Items by Tag
SearchCards and notes marked with one tag.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Style | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
2other output fields
Get Items of a Group by ID
SearchEverything inside one item group.
| Field | Type |
|---|---|
Board IDRequired | choice |
Group IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Parent | object |
| Parent ID | text |
4other output fields
Get Items on Board
SearchEverything on a board, filterable by type.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Item Type | choice |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Slot ID | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent | object |
| Parent ID | text |
| Links | object |
6other output fields
Get Items on Board (Experimental)
SearchExperimental-API item listing for a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Item Type | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Is Root (mind map node) | boolean |
| Direction (mind map node) | text |
| Node View (mind map node) | object |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Get Items Within a Frame
SearchChild items nested in a frame.
| Field | Type |
|---|---|
Board IDRequired | choice |
Frame IDRequired | text |
| Item Type Filter | choice |
| Limit | number |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Style | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
3other output fields
Get Legal Hold Information
SearchFull record of one legal hold and its status.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
Legal Hold IDRequired | text |
| Field | Type |
|---|---|
| Legal Hold ID | text |
| Organization ID | text |
| Case ID | text |
| Name | text |
| Description | text |
| State | text |
5other output fields
Get Mind Map Nodes
SearchAll nodes across the mind maps of a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Node View | object |
| Is Root | boolean |
| Direction | text |
| Style | object |
| Node Border Color | text |
| Shape | text |
| Font Size | text |
| Created At | date |
| Created By | object |
| User ID | text |
| Type | text |
4other output fields
Get OEmbed Data
SearchEmbed details for a board link.
| Field | Type |
|---|---|
Board URLRequired | text |
| Format | choice |
| Max Width | number |
| Max Height | number |
| Field | Type |
|---|---|
| Embed HTML | text |
| Title | text |
| Author | text |
| Version | text |
| Type | text |
| Thumbnail URL | text |
4other output fields
Get Organization Info
SearchPlan and license totals of an organization.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Field | Type |
|---|---|
| Organization ID | text |
| Name | text |
| Plan | text |
| Full Licenses Purchased | number |
| Type | text |
Get Organization Members
SearchSearchable roster of people and seats.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Limit | number |
| Emails | text |
| Role | choice |
| License | choice |
| Active Only | boolean |
| Field | Type |
|---|---|
| Member ID | text |
| text | |
| Active | boolean |
| Role | text |
| License | text |
| Last Activity At | date |
3other output fields
Get Organization Settings
SearchBoard classification setup for an organization.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Field | Type |
|---|---|
| Type | text |
| Enabled | boolean |
| Labels | array |
Get Project Settings
SearchSharing rules of a project.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Field | Type |
|---|---|
| Sharing Policy Settings | object |
| Team Access | text |
| Object Type | text |
Get Results for a Board Export Job
SearchDownload links of a completed export.
| Field | Type |
|---|---|
Organization IDRequired | text |
Job IDRequired | text |
| Field | Type |
|---|---|
| Job ID | text |
| Results | array |
Get SCIM Service Provider Config
SearchCapabilities of the Miro SCIM service.
| Field | Type |
|---|---|
| Patch Support | object |
| Supported | boolean |
| Bulk Support | object |
| Supported | boolean |
| Filter Support | object |
| Supported | boolean |
| Max Results | number |
| Change Password Support | object |
| Supported | boolean |
| Sort Support | object |
| Supported | boolean |
| ETag Support | object |
| Supported | boolean |
1other output field
Get Tags From a Board
SearchTags available for labeling items on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Tag ID | text |
| Title | text |
| Fill Color | text |
| Type | text |
Get Tags From an Item
SearchTags carried by a single board item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| Tag ID | text |
| Title | text |
| Fill Color | text |
| Type | text |
Get Team Classification Settings
SearchDefault labeling settings of one team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Field | Type |
|---|---|
| Default Label ID | text |
| Enabled | boolean |
| Type | text |
Get Team Settings
SearchSharing and collaboration rules of a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Field | Type |
|---|---|
| Organization ID | text |
| Team ID | text |
| Account Discovery Settings | object |
| Account Discovery | text |
| Collaboration Settings | object |
| Co-Owner Role | text |
| Copy Access Level Settings | object |
| Copy Access Level | text |
| Copy Access Level Limitation | text |
| Invitation Settings | object |
| Invite External Users | text |
| Who Can Invite | text |
2other output fields
Get Teams of a User Group
SearchGroup-to-team memberships and access levels.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Team ID | text |
| Role | text |
| Object Type | text |
Get the Tasks of a Board Export Job
SearchPer-board work items inside an export job.
| Field | Type |
|---|---|
Organization IDRequired | text |
Job IDRequired | text |
LimitRequired | number |
| Status | text |
| Field | Type |
|---|---|
| Task ID | text |
| Status | text |
| Artifact Expires At | date |
| Size (bytes) | number |
| Error Message | text |
| Error Type | text |
1other output field
Get the Team of a User Group
SearchTeam-side view of where a group belongs.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
TeamRequired | choice |
| Field | Type |
|---|---|
| Team ID | text |
| Role | text |
| Object Type | text |
Get the User Group Assignments of a Board
SearchGroups with access to one board, by role.
| Field | Type |
|---|---|
Organization IDRequired | text |
BoardRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| User Group ID | text |
| Role | text |
| Object Type | text |
Get the User Group Assignments of a Project
SearchGroups holding access on one project.
| Field | Type |
|---|---|
Organization IDRequired | text |
ProjectRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| User Group ID | text |
| Role | text |
| Object Type | text |
List Project Members
SearchEveryone with a seat in a project.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Role | text |
| Object Type | text |
List Projects
SearchProjects belonging to a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Object Type | text |
List SCIM Groups
SearchGroups managed through SCIM.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| SCIM Group ID | text |
| Display Name | text |
| Members | array |
List SCIM Resource Types
SearchResource types available over SCIM.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Endpoint | text |
| Schema URI | text |
List SCIM Schemas
SearchAll schemas defined for provisioning.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| Schema URI | text |
| Name | text |
| Description | text |
| Attributes | array |
List SCIM Users
SearchOrganization members listed through SCIM.
| Field | Type |
|---|---|
| Limit | number |
| Filter | text |
| Field | Type |
|---|---|
| SCIM User ID | text |
| Username / Email | text |
| Name | object |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
1other output field
List Team Members
SearchRoster of a team, filterable by role.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Limit | number |
| Role | choice |
| Field | Type |
|---|---|
| ID | text |
| Team ID | text |
| Role | text |
| Created At | date |
| Created By | text |
| Modified At | date |
2other output fields
List Teams
SearchTeams in an organization, searchable by name.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Limit | number |
| Name Contains | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Picture | object |
| ID | number |
| Image URL | text |
| Original URL | text |
| Object Type | text |
List User Group Members
SearchPeople enrolled in a user group.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| User ID | text |
| text | |
| Object Type | text |
List User Group to Team Connections
SearchGroups connected to a team, with roles.
| Field | Type |
|---|---|
Organization IDRequired | text |
TeamRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| User Group ID | text |
| Role | text |
| Object Type | text |
List User Groups
SearchNames and descriptions of every group.
| Field | Type |
|---|---|
Organization IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| User Group ID | text |
| Name | text |
| Description | text |
| Object Type | text |
Add a Member to a Project
ActionGives one user a role level in a project.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
EmailRequired | text |
RoleRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Role | text |
| Object Type | text |
Add a Member to a User Group
ActionPuts a person into a group.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
EmailRequired | text |
| Field | Type |
|---|---|
| User ID | text |
| text | |
| Object Type | text |
Attach a Tag to an Item
ActionLabels one board item with a tag.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| Status code | number |
Bulk Edit Membership of a User Group
ActionSeveral group joins and removals at once.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
| Members to Add | array |
| Members to Remove | array |
| Field | Type |
|---|---|
| Results | array |
Bulk Update Boards Classification
ActionSets one classification on many boards.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Label IDRequired | text |
| Not Classified Only | boolean |
| Field | Type |
|---|---|
| Number Of Updated Boards | number |
| Type | text |
Cancel a Board Export Job
ActionStops an in-progress board export.
| Field | Type |
|---|---|
Organization IDRequired | text |
Job IDRequired | text |
| Field | Type |
|---|---|
| Status | text |
Close a Case
ActionFinishes a case and removes it.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
Close a Legal Hold
ActionFrees held boards and custodians.
| Field | Type |
|---|---|
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.
| Field | Type |
|---|---|
Organization IDRequired | text |
TeamRequired | choice |
User GroupRequired | choice |
| Field | Type |
|---|---|
| User Group ID | text |
| Role | text |
| Object Type | text |
Copy a Board
ActionClones a board, optionally under a new name and team.
| Field | Type |
|---|---|
Board To CopyRequired | choice |
| Name | text |
| Description | text |
| Team ID | text |
| Sharing Policy | object |
| Permissions Policy | object |
| Sharing Access Policy | object |
| Field | Type |
|---|---|
| Board ID | text |
| Name | text |
| Description | text |
| Type | text |
| View Link | url |
| Created At | date |
9other output fields
Create a Board
ActionNew blank board with team, project and sharing options.
| Field | Type |
|---|---|
| Name | text |
| Description | text |
| Team ID | text |
| Project ID | text |
| Sharing Policy | object |
| Permissions Policy | object |
| Sharing Access Policy | object |
| Field | Type |
|---|---|
| Board ID | text |
| Name | text |
| Description | text |
| Type | text |
| View Link | url |
| Created At | date |
10other output fields
Create a Board Export Job
ActionStarts a bulk board export.
| Field | Type |
|---|---|
Organization IDRequired | text |
Board IDsRequired | choice |
| Board Format | choice |
| Field | Type |
|---|---|
| Job ID | text |
Create a Board Group
ActionGroups several board items.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDsRequired | array |
| Field | Type |
|---|---|
| Group ID | text |
| Type | text |
| Data | object |
| Data | object |
| Links | object |
| Self | url |
Create a Card Item
ActionCard with an owner and deadline.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Data | object |
| Title | text |
| Description | text |
| Assignee ID | text |
| Due Date | date |
| Style | object |
| Card Theme | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent Frame ID | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Assignee ID | text |
| Due Date | date |
| Style | object |
| Card Theme (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Create a Case
ActionStarts an eDiscovery case.
| Field | Type |
|---|---|
Organization IDRequired | text |
NameRequired | text |
| Description | text |
| Field | Type |
|---|---|
| Case ID | text |
| Organization ID | text |
| Name | text |
| Description | text |
| Created By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Last Modified By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
2other output fields
Create a Code Widget Item
ActionSyntax-highlighted code block on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
CodeRequired | text |
| Title | text |
| Language | text |
| Show Line Numbers | boolean |
| Parent Frame ID | text |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Code | text |
| Language | text |
| Line Numbers Visible | boolean |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
4other output fields
Create a Connector
ActionJoins two board items with a line.
| Field | Type |
|---|---|
Board IDRequired | choice |
Start Item IDRequired | text |
End Item IDRequired | text |
| Shape | choice |
| Start Item Position | object |
| X | text |
| Y | text |
| Start Item Snap To | choice |
4other input fields
| Field | Type |
|---|---|
| Connector ID | text |
| Type | text |
| Shape | text |
| Is Supported | boolean |
| Start Item | object |
| Item ID | text |
| Position | object |
| End Item | object |
| Item ID | text |
| Position | object |
7other output fields
Create a Doc Format Item
ActionMarkdown doc item on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
ContentRequired | text |
| Content Version | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content Type | text |
| Content | text |
| Content Version | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Created At | date |
| Created By | object |
| User ID | text |
| Type | text |
4other output fields
Create a Document Item From a File
ActionUploaded file shown as a board document.
| Field | Type |
|---|---|
Board IDRequired | choice |
FileRequired | text |
| Title | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Document URL | url |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Width | number |
| Created At | date |
4other output fields
Create a Document Item From a URL
ActionDocument from a web address shown on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Document URLRequired | url |
| Title | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Document URL | url |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Create a Frame
ActionFrame for organizing a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Title | text |
| Format | choice |
| Type | choice |
| Show Content | boolean |
| Fill Color | text |
6other input fields
| Field | Type |
|---|---|
| Frame ID | text |
| Type | text |
| Data | object |
| Title | text |
| Format | text |
| Frame Type | text |
| Show Content | boolean |
| Style | object |
| Fill Color | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
3other output fields
Create a Legal Hold
ActionHolds the content of chosen users.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
NameRequired | text |
UsersRequired | array |
| Description | text |
| Field | Type |
|---|---|
| Legal Hold ID | text |
| Organization ID | text |
| Case ID | text |
| Name | text |
| Description | text |
| State | text |
5other output fields
Create a Mind Map Node
ActionChild or root node in a board mind map.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Content | text |
| Parent Node ID | text |
| X Position | number |
| Y Position | number |
| Width | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Node View | object |
| Is Root | boolean |
| Direction | text |
| Style | object |
| Node Border Color | text |
| Shape | text |
| Font Size | text |
| Created At | date |
| Created By | object |
| User ID | text |
| Type | text |
4other output fields
Create a Project
ActionA Space for related boards.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Project ID | text |
| Name | text |
| Type | text |
Create a SCIM Group
ActionUser group created over SCIM.
| Field | Type |
|---|---|
Display NameRequired | text |
| Initial Member User IDs | array |
| Field | Type |
|---|---|
| SCIM Group ID | text |
| Display Name | text |
| Members | array |
Create a SCIM User
ActionSCIM-provisioned user account with profile data.
| Field | Type |
|---|---|
Username / EmailRequired | text |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
| Field | Type |
|---|---|
| SCIM User ID | text |
| Username / Email | text |
| Name | object |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
1other output field
Create a Shape Item
ActionColored shape with text on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Data | object |
| Content | text |
| Shape | choice |
| Style | object |
| Fill Color | text |
| Text Color | text |
| Fill Opacity | text |
| Border Color | text |
| Border Opacity | text |
| Border Style | choice |
| Border Width | text |
| Font Size | text |
| Font Family | choice |
| Text Align | choice |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent Frame ID | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Create a Shape Item (Experimental)
ActionFlowchart-capable shape via the experimental API.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Shape | choice |
| Content | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
14other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Create a Sticky Note Item
ActionColored sticky note posted on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Data | object |
| Content | text |
| Shape | choice |
| Style | object |
| Fill Color | choice |
| Text Align | choice |
| Text Align Vertical | choice |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Parent Frame ID | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Fill Color | text |
| Text Align | text |
| Text Align Vertical | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Create a Tag
ActionColor-coded board tag.
| Field | Type |
|---|---|
Board IDRequired | choice |
TitleRequired | text |
| Fill Color | choice |
| Field | Type |
|---|---|
| Tag ID | text |
| Title | text |
| Fill Color | text |
| Type | text |
| Links | object |
| Self | text |
Create a Task Export Link
ActionDownload address for one task result.
| Field | Type |
|---|---|
Organization IDRequired | text |
Job IDRequired | text |
Task IDRequired | text |
| Field | Type |
|---|---|
| Status | text |
| Export Link | text |
| Artifact Expires At | date |
| Link Expires At | date |
Create a Team
ActionNew team for boards and projects.
| Field | Type |
|---|---|
Organization IDRequired | text |
NameRequired | text |
| Field | Type |
|---|---|
| Team ID | text |
| Name | text |
| Picture | object |
| Picture ID | number |
| Image URL | url |
| Original URL | url |
| Type | text |
| Type | text |
Create a Text Item
ActionFree-standing text on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
ContentRequired | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
| Width | number |
7other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Style | object |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Create a User Group
ActionAccess group of people in an organization.
| Field | Type |
|---|---|
Organization IDRequired | text |
NameRequired | text |
| Description | text |
| Field | Type |
|---|---|
| User Group ID | text |
| Name | text |
| Description | text |
| Object Type | text |
Create an App Card Item
ActionApp card with a connection status badge.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Data | object |
| Title | text |
| Description | text |
| Status | choice |
| Fields | array |
| Style | object |
| Fill Color | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent Frame ID | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Status | text |
| Owned By This App | boolean |
| Fields | array |
| Style | object |
| Fill Color (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Create an Embed Item
ActionExternal content embedded in a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
URLRequired | url |
| Display Mode | choice |
| Preview Image URL | url |
| Parent Frame ID | text |
| X Position | number |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| URL | url |
| Mode | text |
| Content Type | text |
| Title | text |
| Description | text |
| HTML | text |
| Preview URL | url |
| Provider Name | text |
| Provider URL | url |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Create an Image Item From a File
ActionUploaded image file placed on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
FileRequired | text |
| Title | text |
| Alt Text | text |
| Parent Frame ID | text |
| X Position | number |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Width | number |
| Created At | date |
4other output fields
Create an Image Item From a URL
ActionOnline image shown on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Image URLRequired | url |
| Title | text |
| Alt Text | text |
| Parent Frame ID | text |
| X Position | number |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Create Items in Bulk
ActionBatch creation of mixed board items.
| Field | Type |
|---|---|
Board IDRequired | choice |
ItemsRequired | array |
| Field | Type |
|---|---|
| Type | text |
| Created Items | array |
Create Items in Bulk From Files
ActionBatch of uploaded files turned into board items.
| Field | Type |
|---|---|
Board IDRequired | choice |
FilesRequired | array |
Item Metadata (JSON)Required | text |
| Field | Type |
|---|---|
| Type | text |
| Created Items | array |
Delete a Board
ActionDeletes a whole board and its content.
| Field | Type |
|---|---|
Board IDRequired | choice |
Delete a Card Item
ActionRemoves one task-style card.
| Field | Type |
|---|---|
Board IDRequired | choice |
Card Item IDRequired | text |
Delete a Code Widget Item
ActionDeletes a snippet from the experimental API.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a Connector
ActionRemoves the link drawn between two items.
| Field | Type |
|---|---|
Board IDRequired | choice |
Connector IDRequired | text |
Delete a Doc Format Item
ActionRemoves a formatted doc item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a Document Item
ActionClears a document file item away.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a Frame
ActionDeletes one frame container on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Frame IDRequired | text |
| Field | Type |
|---|---|
| Status code | number |
Delete a Group of Items
ActionDissolves a group, deleting its items on request.
| Field | Type |
|---|---|
Board IDRequired | choice |
Group IDRequired | text |
Delete Items In GroupRequired | boolean |
Delete a Mind Map Node
ActionRemoves a mind map branch, children included.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a Project
ActionDeletes a Space owned by a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Delete a SCIM Group
ActionRemoves a group managed through SCIM.
| Field | Type |
|---|---|
SCIM Group IDRequired | text |
Delete a SCIM User
ActionAccount removal through SCIM.
| Field | Type |
|---|---|
SCIM User IDRequired | text |
Delete a Shape Item
ActionRemoves one drawn shape on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Shape Item IDRequired | text |
Delete a Shape Item (Experimental)
ActionExperimental-API deletion of a shape.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a Sticky Note Item
ActionThrows away a sticky note.
| Field | Type |
|---|---|
Board IDRequired | choice |
Sticky Note Item IDRequired | text |
Delete a Tag
ActionDeletes a tag and detaches it everywhere.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Field | Type |
|---|---|
| Status code | number |
Delete a Team
ActionDeletes a whole team and its place in the organization.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Delete a Text Item
ActionDeletes a text block from a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete a User Group
ActionRemoves an organization group and memberships.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
Delete an App Card Item
ActionClears one app card from a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
App Card Item IDRequired | text |
Delete an Embed Item
ActionDeletes an embedded video or page from a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete an Image Item
ActionRemoves a picture item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete an Item
ActionType-agnostic removal of a board item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Delete an Item (Experimental)
ActionExperimental-API variant of item deletion.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
Disconnect a User Group From a Team
ActionBreaks the tie of a group with a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
TeamRequired | choice |
User GroupRequired | choice |
Edit a Case
ActionRewrites the title and summary of a case.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| Case ID | text |
| Organization ID | text |
| Name | text |
| Description | text |
| Created By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Last Modified By | object |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
2other output fields
Edit a Legal Hold
ActionReplaces the user list of a legal hold.
| Field | Type |
|---|---|
Organization IDRequired | text |
Case IDRequired | choice |
Legal Hold IDRequired | text |
UsersRequired | array |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| Legal Hold ID | text |
| Organization ID | text |
| Case ID | text |
| Name | text |
| Description | text |
| State | text |
5other output fields
Invite Team Members
ActionBrings an organization member into a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
EmailRequired | text |
| Role | choice |
| Field | Type |
|---|---|
| Team Member ID | text |
| Team ID | text |
| Role | text |
| Created At | date |
| Created By | text |
| Modified At | date |
2other output fields
Make an API Call
universalFree-form Miro REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Move a Code Widget Item
ActionRelocates a code snippet around the canvas.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| X Position | number |
| Y Position | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Code | text |
| Language | text |
| Line Numbers Visible | boolean |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
4other output fields
Patch a SCIM Group
ActionSelective edits to a SCIM group.
| Field | Type |
|---|---|
SCIM Group IDRequired | text |
OperationsRequired | array |
| Field | Type |
|---|---|
| SCIM Group ID | text |
| Display Name | text |
| Members | array |
Patch a SCIM User
ActionSelective edits to one SCIM user.
| Field | Type |
|---|---|
SCIM User IDRequired | text |
OperationsRequired | array |
| Field | Type |
|---|---|
| SCIM User ID | text |
| Username / Email | text |
| Name | object |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
1other output field
Remove a Board Member
ActionRevokes collaborator access to a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Board Member IDRequired | text |
Remove a Member From a Team
ActionRevokes a team membership.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
Remove a Member From a User Group
ActionRevokes a place in a user group.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
User IDRequired | text |
Remove a Project Member
ActionEnds a project membership.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
Remove a Tag From an Item
ActionUnlinks one board tag from an item.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Field | Type |
|---|---|
| Status code | number |
Remove a User Group From a Board
ActionRevokes group access to a board.
| Field | Type |
|---|---|
Organization IDRequired | text |
BoardRequired | choice |
User GroupRequired | choice |
Remove a User Group From a Project
ActionCancels a group project share.
| Field | Type |
|---|---|
Organization IDRequired | text |
ProjectRequired | choice |
User GroupRequired | choice |
Replace a SCIM User
ActionFull profile replacement of a SCIM user.
| Field | Type |
|---|---|
SCIM User IDRequired | text |
Username / EmailRequired | text |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
1other input field
| Field | Type |
|---|---|
| SCIM User ID | text |
| Username / Email | text |
| Name | object |
| First Name | text |
| Last Name | text |
| Display Name | text |
| License Type | text |
| Active | boolean |
1other output field
Reset All Sessions of a User
ActionEnds every active login of one user.
| Field | Type |
|---|---|
EmailRequired | text |
Share a Board
ActionEmails an invitation to open a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
EmailsRequired | array |
| Role | choice |
| Message | text |
| Field | Type |
|---|---|
| Successful Invites | array |
| Failed Invites | array |
Share a Board With User Groups
ActionGrants whole groups access to one board.
| Field | Type |
|---|---|
Organization IDRequired | text |
BoardRequired | choice |
User GroupsRequired | choice |
RoleRequired | choice |
| Field | Type |
|---|---|
| Results | array |
Share a Project With User Groups
ActionGives groups a role in a project.
| Field | Type |
|---|---|
Organization IDRequired | text |
ProjectRequired | choice |
User GroupsRequired | choice |
RoleRequired | choice |
| Field | Type |
|---|---|
| Results | array |
Ungroup Items
ActionDissolves a group and optionally its items.
| Field | Type |
|---|---|
Board IDRequired | choice |
Group IDRequired | text |
| Also Delete Items | boolean |
Update a Board
ActionEdits the name, home or sharing of a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Name | text |
| Description | text |
| Team ID | text |
| Project ID | text |
| Sharing Policy | object |
| Permissions Policy | object |
| Sharing Access Policy | object |
| Field | Type |
|---|---|
| Board ID | text |
| Name | text |
| Description | text |
| Type | text |
| View Link | url |
| Created At | date |
10other output fields
Update a Board Classification
ActionSets the classification label of one board.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Board IDRequired | choice |
Label IDRequired | text |
| Field | Type |
|---|---|
| Label ID | text |
| Name | text |
| Color | text |
| Description | text |
| Sharing Recommendation | text |
| Guideline URL | url |
1other output field
Update a Board Member
ActionChanges a collaborator role level on a board.
| Field | Type |
|---|---|
Board IDRequired | choice |
Board Member IDRequired | text |
RoleRequired | choice |
| Field | Type |
|---|---|
| Board Member ID | text |
| Name | text |
| Role | text |
| Type | text |
| Links | object |
| Self | url |
Update a Card Item
ActionEdits the text, owner or deadline of a card.
| Field | Type |
|---|---|
Board IDRequired | choice |
Card Item IDRequired | text |
| Data | object |
| Title | text |
| Description | text |
| Assignee ID | text |
| Due Date | date |
| Style | object |
| Card Theme | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
1other input field
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Assignee ID | text |
| Due Date | date |
| Style | object |
| Card Theme (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Update a Code Widget Item
ActionEdits the source or look of a code snippet.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Code | text |
| Title | text |
| Language | text |
| Show Line Numbers | boolean |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Code | text |
| Language | text |
| Line Numbers Visible | boolean |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
4other output fields
Update a Connector
ActionChanges endpoints, route or labels of a connector.
| Field | Type |
|---|---|
Board IDRequired | choice |
Connector IDRequired | text |
| Start Item ID | text |
| End Item ID | text |
| Shape | choice |
| Start Item Position | object |
| X | text |
| Y | text |
5other input fields
| Field | Type |
|---|---|
| Connector ID | text |
| Type | text |
| Shape | text |
| Is Supported | boolean |
| Start Item | object |
| Item ID | text |
| Position | object |
| End Item | object |
| Item ID | text |
| Position | object |
7other output fields
Update a Document Item From a File
ActionSwaps a board document for a newly uploaded file.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
FileRequired | text |
| Title | text |
| Parent Frame ID | text |
| X Position | number |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Document URL | url |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Width | number |
| Created At | date |
4other output fields
Update a Document Item From a URL
ActionRe-links a board document to another web address.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Document URL | url |
| Title | text |
| Parent Frame ID | text |
| X Position | number |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Document URL | url |
| Title | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Update a Frame
ActionRenames, recolors or resizes a frame.
| Field | Type |
|---|---|
Board IDRequired | choice |
Frame IDRequired | text |
| Title | text |
| Format | choice |
| Type | choice |
| Show Content | boolean |
7other input fields
| Field | Type |
|---|---|
| Frame ID | text |
| Type | text |
| Data | object |
| Title | text |
| Format | text |
| Frame Type | text |
| Show Content | boolean |
| Style | object |
| Fill Color | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
1other output field
Update a Group With New Items
ActionRedefines which items make up a group.
| Field | Type |
|---|---|
Board IDRequired | choice |
Group IDRequired | text |
Item IDsRequired | array |
| Field | Type |
|---|---|
| Group ID | text |
| Type | text |
| Data | object |
| Data | object |
| Links | object |
| Self | url |
Update a Project
ActionRenames a team project.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Project ID | text |
| Name | text |
| Type | text |
Update a Project Member
ActionChanges access level inside a project.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
RoleRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Role | text |
| Object Type | text |
Update a Shape Item
ActionEdits the style, text or size of a shape.
| Field | Type |
|---|---|
Board IDRequired | choice |
Shape Item IDRequired | text |
| Data | object |
| Content | text |
| Shape | choice |
| Style | object |
| Fill Color | text |
| Text Color | text |
| Fill Opacity | text |
| Border Color | text |
| Border Opacity | text |
| Border Style | choice |
| Border Width | text |
| Font Size | text |
| Font Family | choice |
| Text Align | choice |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
1other input field
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Update a Shape Item (Experimental)
ActionExperimental-API edit of a flowchart shape.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Shape | choice |
| Content | text |
| Parent Frame ID | text |
| X Position | number |
15other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Border Color | text |
| Border Opacity | text |
| Border Style | text |
| Border Width | text |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Update a Sticky Note Item
ActionEdits the text or color of a sticky note.
| Field | Type |
|---|---|
Board IDRequired | choice |
Sticky Note Item IDRequired | text |
| Data | object |
| Content | text |
| Shape | choice |
| Style | object |
| Fill Color | choice |
| Text Align | choice |
| Text Align Vertical | choice |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
1other input field
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Content | text |
| Shape | text |
| Style | object |
| Fill Color | text |
| Text Align | text |
| Text Align Vertical | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Update a Tag
ActionEdits the name or color of a tag.
| Field | Type |
|---|---|
Board IDRequired | choice |
| Title | text |
| Fill Color | choice |
| Field | Type |
|---|---|
| Tag ID | text |
| Title | text |
| Fill Color | text |
| Type | text |
| Links | object |
| Self | text |
Update a Team
ActionChanges the display name of a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Team ID | text |
| Name | text |
| Picture | object |
| Picture ID | number |
| Image URL | url |
| Original URL | url |
| Type | text |
| Type | text |
Update a Team Member
ActionPromotes or demotes a team member.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
Member IDRequired | text |
RoleRequired | choice |
| Field | Type |
|---|---|
| Team Member ID | text |
| Team ID | text |
| Role | text |
| Created At | date |
| Created By | text |
| Modified At | date |
2other output fields
Update a Text Item
ActionEdits the wording or typography of a text block.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Content | text |
| Parent Frame ID | text |
| X Position | number |
| Y Position | number |
8other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Content | text |
| Style | object |
| Text Color | text |
| Fill Color | text |
| Fill Opacity | text |
| Font Family | text |
| Font Size | text |
| Text Align | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
6other output fields
Update a User Group
ActionChanges the name or notes of a user group.
| Field | Type |
|---|---|
Organization IDRequired | text |
User GroupRequired | choice |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| User Group ID | text |
| Name | text |
| Description | text |
| Object Type | text |
Update an App Card Item
ActionEdits the status or fields of an app card.
| Field | Type |
|---|---|
Board IDRequired | choice |
App Card Item IDRequired | text |
| Data | object |
| Title | text |
| Description | text |
| Status | choice |
| Fields | array |
| Style | object |
| Fill Color | text |
| Position | object |
| X | number |
| Y | number |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
1other input field
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | object |
| Title | text |
| Description | text |
| Status | text |
| Owned By This App | boolean |
| Fields | array |
| Style | object |
| Fill Color (Hex Color) | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
6other output fields
Update an Embed Item
ActionEdits the link or display of an embed.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| URL | url |
| Display Mode | choice |
| Preview Image URL | url |
| Parent Frame ID | text |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| URL | url |
| Mode | text |
| Content Type | text |
| Title | text |
| Description | text |
| HTML | text |
| Preview URL | url |
| Provider Name | text |
| Provider URL | url |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Update an Image Item From a File
ActionReplaces a board image with an uploaded file.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
FileRequired | text |
| Title | text |
| Alt Text | text |
| Parent Frame ID | text |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Geometry | object |
| Height | number |
| Width | number |
| Created At | date |
4other output fields
Update an Image Item From a URL
ActionRe-links a board image to another address.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Parent Frame ID | text |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Data | object |
| Image URL | url |
| Title | text |
| Alt Text | text |
| Position | object |
| Origin | text |
| Relative To | text |
| X | number |
| Y | number |
| Slot ID | text |
| Geometry | object |
| Height | number |
| Rotation | number |
| Width | number |
| Created At | date |
5other output fields
Update an Item Position or Parent
ActionRelocates an item or moves it into a frame.
| Field | Type |
|---|---|
Board IDRequired | choice |
Item IDRequired | text |
| Position | object |
| X | number |
| Y | number |
| Parent Frame ID | text |
| Field | Type |
|---|---|
| Item ID | text |
| Type | text |
| Data | text |
| Position | object |
| X | number |
| Y | number |
| Origin | text |
| Relative To | text |
| Geometry | object |
| Width | number |
| Height | number |
| Rotation | number |
| Parent | object |
| Parent ID | text |
5other output fields
Update Project Settings
ActionSwitches a project between private and team view.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Team Access | choice |
| Field | Type |
|---|---|
| Sharing Policy Settings | object |
| Team Access | text |
| Object Type | text |
Update Team Classification Settings
ActionSwitches classification and its default label for a team.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Enabled | boolean |
| Default Label ID | text |
| Field | Type |
|---|---|
| Default Label ID | text |
| Enabled | boolean |
| Type | text |
Update Team Settings
ActionEdits discovery, collaboration, copy and sharing rules.
| Field | Type |
|---|---|
Organization IDRequired | text |
Team IDRequired | choice |
| Account Discovery Settings | object |
| Account Discovery | text |
| Collaboration Settings | object |
| Co-Owner Role | text |
| Copy Access Level Settings | object |
| Copy Access Level | text |
| Copy Access Level Limitation | text |
| Invitation Settings | object |
| Invite External Users | text |
| Who Can Invite | text |
1other input field
| Field | Type |
|---|---|
| Organization ID | text |
| Team ID | text |
| Account Discovery Settings | object |
| Account Discovery | text |
| Collaboration Settings | object |
| Co-Owner Role | text |
| Copy Access Level Settings | object |
| Copy Access Level | text |
| Copy Access Level Limitation | text |
| Invitation Settings | object |
| Invite External Users | text |
| Who Can Invite | text |
2other output fields
Templates
Look for Miro templates in the WEXTL template library.
Browse templates →Other project management integrations on WEXTL
Google Tasks[2]Google Tasks lists and task items.
BigChangeField service management platform for scheduling jobs, technicians, and customer work orders.
Fishbowl InventoryInventory and manufacturing ERP for tracking parts, purchase orders, and warehouse stock.
Asset PandaFlexible asset tracking and workflow management for equipment, inventory, and audits.
FieldwireConstruction project management for tasks, submittals, plans, and field coordination.
References
- WEXTL® Miro Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Miro.
- 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.






























