> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/miro.md).

# Miro

Miro is a visual collaboration whiteboard. Connect to create and manage boards, frames, cards, and other board items from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Miro      | OAuth sign-in  |

#### Miro

Connect to Miro to access and manage your boards and collaboration spaces. Supports reading boards, creating content, and managing board data.

**Set up in Miro**

1. Use a Miro account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Miro**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

**Provider documentation:** [Setup reference](https://developers.miro.com/docs/getting-started).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Miro** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get Boards

Retrieves a list of boards accessible to the user associated with the provided access token. This endpoint supports filtering and sorting through URL query parameters. Customize the response by specifying team\_id, project\_id, or other query parameters. Filtering by team\_id or project\_id (or both) returns results instantly. For other filters, allow a few seconds for indexing of newly created boards. If you're an Enterprise customer with Company Admin permissions:

**Inputs**

| Field      | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Team Id    | string | No       | The team\_id for which you want to retrieve the list of boards. If this parameter is sent in the request, the `query` and `owner` parameters are ignored.                                                                                                                                                                                                                                                                                                                                                                                                           |
| Project Id | string | No       | The `project_id` for which you want to retrieve the list of boards.\<br/>**Note:** Projects have been renamed to Spaces. Use this as the unique identifier (ID) of the space. If this parameter is included in the request, the `query` and `owner` parameters are ignored.                                                                                                                                                                                                                                                                                         |
| Query      | string | No       | Retrieves a list of boards that contain the query string provided in the board name or board description. For example, if you want to retrieve a list of boards that have the word `beta` in the board name or description, add `beta` as the `query` parameter value. You can use the `query` parameter with the owner parameter to narrow down the board search results.                                                                                                                                                                                          |
| Owner      | string | No       | Retrieves a list of boards that belong to a specific owner ID. You must pass the owner ID (for example, 3074457353169356300), not the owner name. You can use the 'owner' parameter with the `query` parameter to narrow down the board search results. Note that if you pass the `team_id` in the same request, the `owner` parameter is ignored.                                                                                                                                                                                                                  |
| Limit      | string | No       | The maximum number of boards to retrieve. Default: `20`. Minimum: 1.0. Maximum: 50.0.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Offset     | string | No       | The (zero-based) offset of the first item in the collection to return. Default: `0`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Sort       | string | No       | Sort order in which you want to view the result set. Options `last_created` and `alphabetically` are applicable only when you search for boards by team. \* `default` - If `team_id` is present, `last_created`. Otherwise, `last_opened`. \* `last_modified` - sort by the date and time when the board was last modified. \* `last_opened` - sort by the date and time when the board was last opened. \* `last_created` - sort by the date and time when the board was created. \* `alphabetically` - sort by the board name (alphabetically). Default: default. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Search Boards

Search for boards by name or description with optional team filtering and result limits

**Inputs**

| Field        | Type   | Required | Description                                                |
| ------------ | ------ | -------- | ---------------------------------------------------------- |
| Search Query | string | No       | Search term to find boards by name or description.         |
| Team ID      | string | No       | Filter results to boards owned by specific team.           |
| Result Limit | number | No       | Maximum number of boards to return (default: 20, max: 50). |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Recent Boards

Get recently modified boards, sorted by modification date with optional result limits

**Inputs**

| Field        | Type   | Required | Description                                                       |
| ------------ | ------ | -------- | ----------------------------------------------------------------- |
| Result Limit | number | No       | Maximum number of recent boards to return (default: 20, max: 50). |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Board Details

Retrieve detailed information about a specific board including metadata

**Inputs**

| Field    | Type   | Required | Description                                  |
| -------- | ------ | -------- | -------------------------------------------- |
| Board ID | string | Yes      | The ID of the board to retrieve details for. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Frames

Retrieve all frames on a board for structured content organization

**Inputs**

| Field     | Type   | Required | Description                                                         |
| --------- | ------ | -------- | ------------------------------------------------------------------- |
| Board ID  | string | Yes      | The ID of the board to get frames from.                             |
| Item Type | string | No       | Filter to only return frame items (set to 'frame'). Default: frame. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Board Items

Retrieve all items on a board with optional filtering by item type

**Inputs**

| Field        | Type   | Required | Description                                                          |
| ------------ | ------ | -------- | -------------------------------------------------------------------- |
| Board ID     | string | Yes      | The ID of the board to get items from.                               |
| Item Type    | string | No       | Filter items by type (sticky\_note, text, shape, card, image, etc.). |
| Result Limit | number | No       | Maximum number of items to return (default: 50, max: 50).            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Board Tags

Retrieve all tags used on a board for organization and categorization

**Inputs**

| Field    | Type   | Required | Description                           |
| -------- | ------ | -------- | ------------------------------------- |
| Board ID | string | Yes      | The ID of the board to get tags from. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Board

Creates a board with the specified name and sharing policies. Note: You can only create up to 3 team boards with the free plan.

**Inputs**

| Field        | Type   | Required | Description |
| ------------ | ------ | -------- | ----------- |
| Request Body | object | No       |             |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Copy Board

Creates a copy of an existing board. You can also update the name, description, sharing policy, and permissions policy for the new board in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                |
| ------------ | ------ | -------- | ---------------------------------------------------------- |
| Copy From    | string | Yes      | Unique identifier (ID) of the board that you want to copy. |
| Request Body | object | No       |                                                            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Board

Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.

**Inputs**

| Field    | Type   | Required | Description                                                  |
| -------- | ------ | -------- | ------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board that you want to delete. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Specific Board

Retrieves information about a board.

**Inputs**

| Field    | Type   | Required | Description                                                    |
| -------- | ------ | -------- | -------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board that you want to retrieve. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Board

Updates a specific board.

**Inputs**

| Field        | Type   | Required | Description                                                  |
| ------------ | ------ | -------- | ------------------------------------------------------------ |
| Board Id     | string | Yes      | Unique identifier (ID) of the board that you want to update. |
| Request Body | object | No       |                                                              |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create App Card Item

Adds an app card item to a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete App Card Item

Deletes an app card item from a board.

**Inputs**

| Field    | Type   | Required | Description                                                                |
| -------- | ------ | -------- | -------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete an item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get App Card Item

Retrieves information for a specific app card item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update App Card Item

Updates an app card item on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Card Item

Adds a card item to a board

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Card Item

Deletes a card item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Card Item

Retrieves information for a specific card item on a board

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Card Item

Updates a card item on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Connectors

Retrieves a list of connectors for a specific board. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo. Required sc

**Inputs**

| Field    | Type   | Required | Description                                                                                                                                                                                                                                                                                                                      |
| -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Limit    | string | No       | The maximum number of results to return per call. If the number of connectors in the response is greater than the limit specified, the response returns the cursor parameter with a value. Minimum: 10.0. Maximum: 50.0. Default: 10.                                                                                            |
| Cursor   | string | No       | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a list of connectors.                                                                                                                                                                                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Connector

Adds a connector to a board.

**Inputs**

| Field        | Type   | Required | Description                                                                     |
| ------------ | ------ | -------- | ------------------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board for which you want to create the connector. |
| Request Body | object | No       | startItem.id must be different from endItem.id.                                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Connector

Deletes the specified connector from the board.

**Inputs**

| Field        | Type   | Required | Description                                                                      |
| ------------ | ------ | -------- | -------------------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board from which you want to delete the connector. |
| Connector Id | string | Yes      | Unique identifier (ID) of the connector that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Specific Connector

Retrieves information for a specific connector on a board.

**Inputs**

| Field        | Type   | Required | Description                                                                               |
| ------------ | ------ | -------- | ----------------------------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific connector. |
| Connector Id | string | Yes      | Unique identifier (ID) of the connector that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Connector

Updates a connector on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                                     |
| ------------ | ------ | -------- | ------------------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board for which you want to update the connector. |
| Connector Id | string | Yes      | Unique identifier (ID) of the connector that you want to update.                |
| Request Body | object | No       | If both are provided, startItem.id must be different from endItem.id.           |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Document Item Using Url

Adds a document item to a board by specifying the URL where the document is hosted.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Document Item

Deletes a document item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Document Item

Retrieves information for a specific document item on a board

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Document Item Using Url

Updates a document item on a board

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Embed Item

Adds an embed item containing external content to a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Embed Item

Deletes an embed item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Embed Item

Retrieves information for a specific embed item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Embed Item

Updates an embed item on a board based on the data properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Image Item Using Url

Adds an image item to a board by specifying an image URL.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Image Item

Deletes an image item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Image Item

Retrieves information for a specific image item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Image Item Using Url

Updates an image item on a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Items On Board

Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values. This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the respons

**Inputs**

| Field    | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Limit    | string | No       | The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value. Minimum: 10.0. Maximum: 50.0. Default: 10.                                                                                                                                                                                            |
| Type     | string | No       | If you want to get a list of items of a specific type, specify an item type. For example, if you want to retrieve the list of card items, set `type` to `cards`. A `document` is meant for uploaded documents like PDFs while `doc_format` is a Miro structured document similar to a Google Doc. Possible values: `app_card`, `card`, `document`, `embed`, `frame`, `image`, `shape`, `sticky_note`, `text`, `doc_format`. |
| Cursor   | string | No       | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request.                                                                                            |
| Board Id | string | Yes      | Unique identifier (ID) of the board for which you want to retrieve the list of available items.                                                                                                                                                                                                                                                                                                                             |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Item

Deletes an item from a board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Specific Item On Board

Retrieves information for a specific item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Item Position Or Parent

Updates the position or the parent of an item on a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get All Board Members

Retrieves a pageable list of members for a board.

**Inputs**

| Field    | Type   | Required | Description                                                                                  |
| -------- | ------ | -------- | -------------------------------------------------------------------------------------------- |
| Limit    | string | No       | The maximum number of board members to retrieve. Default: `20`. Minimum: 1.0. Maximum: 50.0. |
| Offset   | string | No       | The (zero-based) offset of the first item in the collection to return. Default: `0`.         |
| Board Id | string | Yes      | Unique identifier (ID) of the board to which the board member belongs.                       |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Share Board

Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board to which the board member belongs. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Remove Board Member

Removes a board member from a board.

**Inputs**

| Field           | Type   | Required | Description                                                                |
| --------------- | ------ | -------- | -------------------------------------------------------------------------- |
| Board Id        | string | Yes      | Unique identifier (ID) of the board from which you want to delete an item. |
| Board Member Id | string | Yes      | Unique identifier (ID) of the board member whose role you want to delete.  |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Specific Board Member

Retrieves information for a board member.

**Inputs**

| Field           | Type   | Required | Description                                                                 |
| --------------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id        | string | Yes      | Unique identifier (ID) of the board to which the board member belongs.      |
| Board Member Id | string | Yes      | Unique identifier (ID) of the board member whose role you want to retrieve. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Board Member

Updates the role of a board member.

**Inputs**

| Field           | Type   | Required | Description                                                                                    |
| --------------- | ------ | -------- | ---------------------------------------------------------------------------------------------- |
| Board Id        | string | Yes      | Unique identifier (ID) of the board for which you want to update the role of the board member. |
| Board Member Id | string | Yes      | Unique identifier (ID) of the board member whose role you want to update.                      |
| Request Body    | object | No       |                                                                                                |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Shape Item

Adds a shape item to a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Shape Item

Deletes a shape item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Shape Item

Retrieves information for a specific shape item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Shape Item

Updates a shape item on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Sticky Note Item

Adds a sticky note item to a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Sticky Note Item

Deletes a sticky note item from the board.

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Sticky Note Item

Retrieves information for a specific sticky note item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Sticky Note Item

Updates a sticky note item on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Create Text Item

Adds a text item to a board.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to create the item. |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Delete Text Item

Deletes a text item from the board

**Inputs**

| Field    | Type   | Required | Description                                                                 |
| -------- | ------ | -------- | --------------------------------------------------------------------------- |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to delete the item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to delete.                 |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Text Item

Retrieves information for a specific text item on a board.

**Inputs**

| Field    | Type   | Required | Description                                                                          |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| Board Id | string | Yes      | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
| Item Id  | string | Yes      | Unique identifier (ID) of the item that you want to retrieve.                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Update Text Item

Updates a text item on a board based on the data and style properties provided in the request body.

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Board Id     | string | Yes      | Unique identifier (ID) of the board where you want to update the item. |
| Item Id      | string | Yes      | Unique identifier (ID) of the item that you want to update.            |
| Request Body | object | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/miro.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
