# Mural

Mural is a digital whiteboard platform enabling distributed teams to visually brainstorm, map ideas, and collaborate in real time with sticky notes and diagrams

- **Category:** team collaboration
- **Auth:** OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `MURAL`
- **Version:** 20260227_00

## Tools

### MURAL Authorization Request

**Slug:** `MURAL_AUTHORIZATION_REQUEST`

Tool to initiate the OAuth 2.0 authorization process. Use when you need to redirect a user to Mural to obtain an authorization code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | array | Yes | List of permission scopes to request. Provided as a list of strings; they will be joined with spaces in the URL. |
| `state` | string | No | Optional opaque value sent and returned in the callback to prevent CSRF and correlate requests. |
| `client_id` | string | Yes | The client identifier for your Mural app (provided when registering your app). |
| `redirect_uri` | string | Yes | The callback URL where users are redirected after granting access. Must match one of your app's registered redirect URLs. |
| `response_type` | string | No | Grant type for authorization code flow; must be 'code'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create sticky note

**Slug:** `MURAL_CREATE_STICKY_NOTE`

Create one or more sticky note widgets on a mural. Each sticky note must be a properly structured object with required x and y coordinates. Pass the 'stickies' parameter as a direct array of objects - NOT strings, NOT nested objects. Example usage: { "muralId": "mural-id-here", "stickies": [ {"x": 100, "y": 200, "text": "First note"}, {"x": 300, "y": 400, "text": "Second note", "shape": "circle"} ] }

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `muralId` | string | Yes | Unique identifier of the mural |
| `stickies` | array | Yes | Array of sticky note objects to create. Each object must have 'x' and 'y' coordinates. Pass objects directly, not strings or nested structures. Maximum 1000 items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current user

**Slug:** `MURAL_GET_CURRENT_USER`

Tool to retrieve information about the currently authenticated user. Use when you need current user details after authentication.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get files for a mural

**Slug:** `MURAL_GET_FILES_FOR_MURAL`

Tool to retrieve a list of file widgets in a mural. Use after confirming the mural ID when listing file attachments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for next page of items |
| `limit` | integer | No | Maximum number of results to return |
| `muralId` | string | Yes | Unique identifier of the mural |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mural Widgets

**Slug:** `MURAL_GET_MURAL_WIDGETS`

Tool to retrieve all widgets within a specified mural. Widgets include sticky notes, text boxes, shapes, images, areas, arrows, icons, files, and comments. Use this after obtaining a valid mural ID from workspace murals or other mural-related actions. Supports filtering by widget type, parent container, and pagination for large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token from previous response to retrieve the next page of results. |
| `type` | array | No | List of widget types to filter by (e.g., ['area', 'sticky note']). When omitted, returns all widget types. |
| `limit` | integer | No | Maximum number of widgets to return per page (must be ≥1). Use with 'next' for pagination. |
| `muralId` | string | Yes | Unique identifier of the mural. |
| `parentId` | string | No | Filter to return only widgets contained within the specified parent widget ID (typically an area widget). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get room by ID

**Slug:** `MURAL_GET_ROOM`

Tool to retrieve information about a specific room by its ID. Use when you need details about a particular room that the authenticated user has read access to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roomId` | string | Yes | Unique identifier of the room to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get workspace by ID

**Slug:** `MURAL_GET_WORKSPACE`

Tool to retrieve information about a specific workspace by its ID. Use when you need details about a particular workspace that the authenticated user has read access to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspaceId` | string | Yes | Unique identifier of the workspace to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get workspaces

**Slug:** `MURAL_GET_WORKSPACES`

Tool to retrieve all workspaces the authenticated user is a member of. Use to list available workspaces before accessing rooms or murals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of workspaces to return per page (must be ≥1) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List folders in room

**Slug:** `MURAL_LIST_FOLDERS`

Tool to list all folders within a room that the authenticated user has access to. Use after MURAL_LIST_ROOMS to navigate folders within a specific room.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of folders to return per page (must be ≥1) |
| `roomId` | string | Yes | Unique identifier of the room to list folders from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List open rooms in workspace

**Slug:** `MURAL_LIST_OPEN_ROOMS`

Tool to list all discoverable open rooms within a workspace. Use when you need to access publicly available rooms in a workspace that don't require specific membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of rooms to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list open rooms from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List recent murals in workspace

**Slug:** `MURAL_LIST_RECENT_MURALS`

Tool to list recently opened active murals for the authenticated user in a workspace. Use after MURAL_LIST_WORKSPACES to view recent murals before opening or editing them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of murals to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list recent murals from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List recent templates

**Slug:** `MURAL_LIST_RECENT_TEMPLATES`

Tool to retrieve recent templates used by a user for a workspace. Use when you need to access recently used templates for creating new murals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of templates to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list recent templates from |
| `withoutDefault` | boolean | No | If true, the list of returned templates will not include default templates |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List murals in room

**Slug:** `MURAL_LIST_ROOM_MURALS`

Tool to list all murals for a room that the authenticated user has read access to. Use after getting a room ID to retrieve murals within that room.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Token to get the next page of items |
| `limit` | integer | No | Maximum number of results to be returned by the endpoint |
| `roomId` | integer | Yes | Unique identifier of the room to list murals from |
| `sortBy` | string ("lastCreated" | "lastModified" | "oldest") | No | Sort order options for murals. |
| `status` | string ("active" | "archived") | No | Status filter for murals. |
| `folderId` | string | No | When set, filter murals by their corresponding folder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List rooms in workspace

**Slug:** `MURAL_LIST_ROOMS`

Tool to list all rooms within a workspace. Use after MURAL_LIST_WORKSPACES to navigate rooms and before MURAL_CREATE_MURAL, since murals are created within rooms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of rooms to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list rooms from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List users in room

**Slug:** `MURAL_LIST_ROOM_USERS`

Tool to list all members and guests for a room. Returns users that the authenticated user has access to view. Use after LIST_ROOMS to get room membership details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of users to return per page (must be ≥1) |
| `roomId` | string | Yes | Unique identifier of the room to list users from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List tags in a mural

**Slug:** `MURAL_LIST_TAGS`

Tool to retrieve all tags in a mural. Use when you need to list or view tags associated with a specific mural.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `muralId` | string | Yes | Unique identifier of a mural |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List default templates

**Slug:** `MURAL_LIST_TEMPLATES`

Tool to retrieve all default templates available in Mural. Use when you need to browse or select from standard Mural templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of templates to return per page (must be ≥1) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List workspace murals

**Slug:** `MURAL_LIST_WORKSPACE_MURALS`

Tool to list all murals in a workspace that the authenticated user owns or is a member of. Use after getting a workspace ID to browse available murals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of murals to return per page (must be ≥1) |
| `sortBy` | string ("lastCreated" | "lastModified" | "oldest") | No | Sort order for murals. |
| `status` | string ("active" | "archived") | No | Status filter for murals. |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list murals from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List workspace templates

**Slug:** `MURAL_LIST_WORKSPACE_TEMPLATES`

Tool to get default and custom templates for a workspace. Use when you need to list available templates after authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of templates to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to list templates from |
| `withoutDefault` | boolean | No | If true, the list of returned templates will not include default templates |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search murals in workspace

**Slug:** `MURAL_SEARCH_MURALS`

Tool to search for murals within a workspace. Returns all murals that the authenticated user owns or is a member of for the specified workspace. Use when searching for specific murals by query text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The text this search query is for |
| `next` | string | No | Token to get the next page of items |
| `limit` | integer | No | Maximum number of results to be returned by the endpoint (must be ≥1) |
| `roomId` | integer | No | Unique identifier of a room. When provided, restrict the results to murals in the specified room. |
| `workspaceId` | string | Yes | Unique identifier of the workspace to search murals in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search rooms in workspace

**Slug:** `MURAL_SEARCH_ROOMS`

Tool to search for rooms within a workspace by name or description. Returns all rooms that the authenticated user owns or is a member of matching the query. Use when you need to find specific rooms by search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The search query text to filter rooms by name or description |
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of rooms to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to search rooms from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search templates in workspace

**Slug:** `MURAL_SEARCH_TEMPLATES`

Tool to search templates within a workspace that the authenticated user owns or has access to. Use when you need to find specific templates by name or keyword.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The text search query for finding templates |
| `next` | string | No | Pagination token for retrieving the next page of results |
| `limit` | integer | No | Maximum number of templates to return per page (must be ≥1) |
| `workspaceId` | string | Yes | Unique identifier of the workspace to search templates in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |