# Miro Developer Platform API

> Miro Developer Platform API on Apizie: 196 endpoints (Get access token information, Get AI interaction logs (Beta), Get audit logs, Get organization settings, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/business:miro/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:miro`
- Category: Business
- Status: byok
- Source: https://miro
- Page: https://www.apizie.tech/api/business/miro
- OpenAPI: https://www.apizie.tech/api/business/miro/openapi.json

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and…

## Endpoints

### Get access token information
`GET https://www.apizie.tech/v1/business:miro/token-info` (byok)

### Get AI interaction logs (Beta)
`GET https://www.apizie.tech/v1/business:miro/enterprise-get-ai-interaction-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| object_ids | array | no | List of object IDs used to retrieve AI interaction logs. Currently, supported object types include board IDs and organization IDs. You can… |
| emails | array | no | Filters AI interaction logs using a list of user emails. Only AI interactions associated with the provided emails will be included in the… |
| from | string | yes | Start date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from -… |
| to | string | yes | End date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from - to… |
| 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… |
| limit | integer | no | The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response… |
| sorting | string | no | Sort order in which you want to view the result set based on the interaction date. To sort by an ascending date, specify `asc`. To sort by… |

### Get audit logs
`GET https://www.apizie.tech/v1/business:miro/enterprise-get-audit-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| createdAfter | string | yes | Retrieve audit logs created after the date and time provided. This is the start date of the duration for which you want to retrieve audit… |
| createdBefore | string | yes | Retrieve audit logs created before the date and time provided. This is the end date of the duration for which you want to retrieve audit… |
| 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… |
| limit | integer | no | Maximum number of results returned based on the `limit` specified in the request. For example, if there are `30` results, the request has… |
| sorting | string | no | Sort order in which you want to view the result set. Based on the value you provide, the results are sorted in an ascending or descending… |

### Get organization settings
`GET https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-organization-settings-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |

### Bulk update boards classification
`POST https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-team-boards-bulk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| team_id | string | yes | id of the team |
| body | object | yes | JSON request body |

### Get team settings
`GET https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-team-settings-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| team_id | string | yes | id of the team |

### Update team settings
`POST https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-team-settings-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| team_id | string | yes | id of the team |
| body | object | yes | JSON request body |

### Get board classification
`GET https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-board-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| team_id | string | yes | id of the team |
| board_id | string | yes | Unique identifier of the board that you want to retrieve. |

### Update board classification
`POST https://www.apizie.tech/v1/business:miro/enterprise-dataclassification-board-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| team_id | string | yes | id of the team |
| board_id | string | yes | Unique identifier of the board that you want to update. |
| body | object | yes | JSON request body |

### Create doc format item
`POST https://www.apizie.tech/v1/business:miro/create-doc-format-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get doc format item
`GET https://www.apizie.tech/v1/business:miro/get-doc-format-item` (byok)

| Parameter | 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. |
| textContentType | string | no | Controls the contentType of the returned doc's content. |

### Delete doc format item
`POST https://www.apizie.tech/v1/business:miro/delete-doc-format-item` (byok)

| Parameter | 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. |

### Get all cases
`GET https://www.apizie.tech/v1/business:miro/get-all-cases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The maximum number of items in the result list. |
| cursor | string | no | An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set… |
| org_id | string | yes | The ID of the organization for which you want to retrieve the list of cases. |

### Create case
`POST https://www.apizie.tech/v1/business:miro/create-case` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization in which you want to create a new case. |
| body | object | yes | JSON request body |

### Get case
`GET https://www.apizie.tech/v1/business:miro/get-case` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization for which you want to retrieve the case information. |
| case_id | string | yes | The ID of the case you want to retrieve. |

### Edit case
`POST https://www.apizie.tech/v1/business:miro/edit-case` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization for which you want to edit the case information. |
| case_id | string | yes | The ID of the case you want to edit. |
| body | object | yes | JSON request body |

### Close case
`POST https://www.apizie.tech/v1/business:miro/delete-case` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization in which you want to close a case. |
| case_id | string | yes | The ID of the case you want to close. |

### Get all legal holds within a case
`GET https://www.apizie.tech/v1/business:miro/get-all-legal-holds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The maximum number of items in the result list. |
| cursor | string | no | An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set… |
| org_id | string | yes | The ID of the organization for which you want to retrieve the list of legal holds within a case. |
| case_id | string | yes | The ID of the case for which you want to retrieve the list of legal holds. |

### Create legal hold
`POST https://www.apizie.tech/v1/business:miro/create-legal-hold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization in which you want to create a new legal hold. |
| case_id | string | yes | The ID of the case in which you want to create a new legal hold. |
| body | object | yes | JSON request body |

### Get board export jobs of a case
`GET https://www.apizie.tech/v1/business:miro/get-legal-hold-export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The maximum number of items in the result list. |
| cursor | string | no | An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set… |
| org_id | string | yes | The ID of the organization for which you want to retrieve the list of export jobs within a case. |
| case_id | string | yes | The ID of the case for which you want to retrieve the list of export jobs. |

### Get legal hold information
`GET https://www.apizie.tech/v1/business:miro/get-legal-hold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization for which you want to retrieve the legal hold information. |
| case_id | string | yes | The ID of the case for which you want to retrieve the legal hold information. |
| legal_hold_id | string | yes | The ID of the legal hold you want to retrieve. |

### Edit legal hold
`POST https://www.apizie.tech/v1/business:miro/edit-legal-hold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization for which you want to edit the legal hold information. |
| case_id | string | yes | The ID of the case for which you want to edit the legal hold information. |
| legal_hold_id | string | yes | The ID of the legal hold you want to edit. |
| body | object | yes | JSON request body |

### Close legal hold
`POST https://www.apizie.tech/v1/business:miro/delete-legal-hold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization in which you want to close a legal hold. |
| case_id | string | yes | The ID of the case in which you want to close a legal hold. |
| legal_hold_id | string | yes | The ID of the legal hold you want to close. |

### Get content items under legal hold
`GET https://www.apizie.tech/v1/business:miro/get-legal-hold-content-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | The ID of the organization for which you want to retrieve the list of content items under hold. |
| case_id | string | yes | The ID of the case for which you want to retrieve the list of content items under hold. |
| legal_hold_id | string | yes | The ID of the legal hold for which you want to retrieve the list of content items under hold. |
| limit | integer | no | The maximum number of items in the result list. |
| cursor | string | no | An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set… |

### Get board export jobs list
`GET https://www.apizie.tech/v1/business:miro/enterprise-board-export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| status | array | no | Status of the board export jobs that you want to retrieve, such as JOB_STATUS_CREATED, JOB_STATUS_IN_PROGRESS, JOB_STATUS_CANCELLED or… |
| creatorId | array | no | Unique identifier of the board export job creator. |
| 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… |
| limit | integer | no | The maximum number of results to return per call. If the number of jobs in the response is greater than the limit specified, the response… |

### Create board export job
`POST https://www.apizie.tech/v1/business:miro/enterprise-create-board-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| request_id | string | yes | Unique identifier of the board export job. |
| body | object | yes | JSON request body |

### Get board export job status
`GET https://www.apizie.tech/v1/business:miro/enterprise-board-export-job-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| job_id | string | yes | Unique identifier of the board export job. |

### Get results for board export job
`GET https://www.apizie.tech/v1/business:miro/enterprise-board-export-job-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| job_id | string | yes | Unique identifier of the job. |

### Update board export job status
`POST https://www.apizie.tech/v1/business:miro/enterprise-update-board-export-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| job_id | string | yes | Unique identifier of the board export job. |
| body | object | no | JSON request body |

### Get board export job tasks list
`GET https://www.apizie.tech/v1/business:miro/enterprise-board-export-job-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| job_id | string | yes | Unique identifier of the board export job. |
| status | array | no | Filters the list of board export tasks by their status. Accepts an array of statuses such as TASK_STATUS_CREATED, TASK_STATUS_CANCELLED,… |
| 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… |
| limit | integer | no | The maximum number of results to return per call. If the number of tasks in the response is greater than the limit specified, the response… |

### Create task export link
`POST https://www.apizie.tech/v1/business:miro/enterprise-create-board-export-task-export-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| job_id | string | yes | Unique identifier of the board export job. |
| task_id | string | yes | Unique identifier of the board export task. |

### Retrieve content change logs of board items
`GET https://www.apizie.tech/v1/business:miro/enterprise-board-content-item-logs-fetch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | Unique identifier of the organization. |
| board_ids | array | no | List of board IDs for which you want to retrieve the content logs. |
| emails | array | no | Filter content logs based on the list of emails of users who created, modified, or deleted the board item. |
| from | string | yes | Filter content logs based on the date and time when the board item was last modified. This is the start date and time for the modified… |
| to | string | yes | Filter content logs based on the date and time when the board item was last modified. This is the end date and time for the modified date… |
| 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… |
| limit | integer | no | The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response… |
| sorting | string | no | Sort order in which you want to view the result set based on the modified date. To sort by an ascending modified date, specify `asc`. To… |

### Reset all sessions of a user
`POST https://www.apizie.tech/v1/business:miro/enterprise-post-user-sessions-reset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email | string | yes | Email ID of the user whose sessions you want to reset. Note that this user will be signed out from all devices. |

### List users
`GET https://www.apizie.tech/v1/business:miro/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attributes | string | no | A comma-separated list of attribute names to return in the response. Example attributes: id, userName, displayName, name, userType,… |
| filter | string | no | You can request a subset of resources by specifying the filter query parameter containing a filter expression. Attribute names and… |
| startIndex | integer | no | Use startIndex in combination with count query parameters to receive paginated results. start index is 1-based. Example: startIndex=1 |
| count | integer | no | Specifies the maximum number of query results per page. Use count in combination with startIndex query parameters to receive paginated… |
| sortBy | string | no | Specifies the attribute whose value will be used to order the response. Example: sortBy=userName, sortBy=emails.value |
| sortOrder | string | no | Defines the order in which the sortBy parameter is applied. Example: sortOrder=ascending |

### Create user
`POST https://www.apizie.tech/v1/business:miro/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get user
`GET https://www.apizie.tech/v1/business:miro/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | User ID of the user to be retrieved |
| attributes | string | no | A comma-separated list of attribute names to return in the response. Example attributes - id, userName, displayName, name, userType,… |

### Replace user
`POST https://www.apizie.tech/v1/business:miro/replace-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | User ID. A server-assigned, unique identifier for this user. |
| body | object | yes | JSON request body |

### Patch user
`POST https://www.apizie.tech/v1/business:miro/patch-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | User ID. A server-assigned, unique identifier for this user. |
| body | object | yes | JSON request body |

### Delete user
`POST https://www.apizie.tech/v1/business:miro/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | User ID. A server-assigned, unique identifier for this user. |

### List groups
`GET https://www.apizie.tech/v1/business:miro/list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attributes | string | no | A comma-separated list of attribute names to return in the response. Example attributes: id,displayName Note : It is also possible to… |
| filter | string | no | You can request a subset of resources by specifying the filter query parameter containing a filter expression. Attribute names and… |
| startIndex | integer | no | Use startIndex in combination with count query parameters to receive paginated results. start index is 1-based. Example: startIndex=1 |
| count | integer | no | Specifies the maximum number of query results per page. Use count in combination with startIndex query parameters to receive paginated… |
| sortBy | string | no | Specifies the attribute whose value will be used to order the response. Example sortBy=displayName |
| sortOrder | string | no | Defines the order in which the 'sortBy' parameter is applied. Example: sortOrder=ascending |

### Get group
`GET https://www.apizie.tech/v1/business:miro/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A server-assigned, unique identifier for this Group (team). |
| attributes | string | no | A comma-separated list of attribute names to return in the response. Example attributes: id,displayName Note : It is also possible to… |

### Patch group
`POST https://www.apizie.tech/v1/business:miro/patch-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Group (Team) ID. A server-assigned, unique identifier for this Group (team). |
| attributes | string | no | A comma-separated list of attribute names to return in the response. Example attributes: id,displayName It is also possible to fetch… |
| body | object | yes | JSON request body |

### Get Service Provider Config
`GET https://www.apizie.tech/v1/business:miro/list-service-provider-configs` (byok)

### List resource types
`GET https://www.apizie.tech/v1/business:miro/list-resource-types` (byok)

### Get resource type
`GET https://www.apizie.tech/v1/business:miro/get-resource-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Resource type identifier for which to retrieve metadata. Supported values are 'User' and 'Group'. |

### List schemas
`GET https://www.apizie.tech/v1/business:miro/list-schemas` (byok)

### Get schema
`GET https://www.apizie.tech/v1/business:miro/get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| uri | string | yes | Schema URI of a particular resource type. |

### Get organization info
`GET https://www.apizie.tech/v1/business:miro/enterprise-get-organization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |

### Get organization members
`GET https://www.apizie.tech/v1/business:miro/enterprise-get-organization-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| emails | string | no | Emails of the organization members you want to retrieve. If you specify a value for the `emails` parameter, only the `emails` parameter is… |
| role | string | no | Filter organization members by role |
| license | string | no | Filter organization members by license |
| active | boolean | no | Filter results based on whether the user is active or deactivated. Learn more about user deactivation . |
| cursor | string | no | The ID of the organization member used as the reference for pagination. To retrieve the first portion of the collection don't pass a… |
| limit | integer | no | Limit for the number of organization members returned in the result list. |
| org_id | string | yes | id of the organization |

### Get organization member
`GET https://www.apizie.tech/v1/business:miro/enterprise-get-organization-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| org_id | string | yes | id of the organization |
| member_id | string | yes | id of the organization member |

### Get boards
`GET https://www.apizie.tech/v1/business:miro/get-boards` (byok)

| Parameter | 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`… |
| project_id | string | no | The `project_id` for which you want to retrieve the list of boards. **Note:** Projects have been renamed to Spaces. Use this as the unique… |
| 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… |
| 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… |
| limit | string | no | The maximum number of boards to retrieve. Default: `20` |
| 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. The parameter is applicable only when you search for boards by team or project. *… |

### Create board
`POST https://www.apizie.tech/v1/business:miro/create-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Copy board
`POST https://www.apizie.tech/v1/business:miro/copy-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| copy_from | string | yes | Unique identifier (ID) of the board that you want to copy. |
| body | object | no | JSON request body |

### Get specific board
`GET https://www.apizie.tech/v1/business:miro/get-specific-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board that you want to retrieve. |

### Update board
`POST https://www.apizie.tech/v1/business:miro/update-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board that you want to update. |
| body | object | yes | JSON request body |

### Delete board
`POST https://www.apizie.tech/v1/business:miro/delete-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board that you want to delete. |

### Create app card item
`POST https://www.apizie.tech/v1/business:miro/create-app-card-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get app card item
`GET https://www.apizie.tech/v1/business:miro/get-app-card-item` (byok)

| Parameter | 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. |

### Update app card item
`POST https://www.apizie.tech/v1/business:miro/update-app-card-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete app card item
`POST https://www.apizie.tech/v1/business:miro/delete-app-card-item` (byok)

| Parameter | 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. |

### Create card item
`POST https://www.apizie.tech/v1/business:miro/create-card-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get card item
`GET https://www.apizie.tech/v1/business:miro/get-card-item` (byok)

| Parameter | 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. |

### Update card item
`POST https://www.apizie.tech/v1/business:miro/update-card-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete card item
`POST https://www.apizie.tech/v1/business:miro/delete-card-item` (byok)

| Parameter | 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. |

### Get connectors
`GET https://www.apizie.tech/v1/business:miro/get-connectors` (byok)

| Parameter | 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… |
| 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… |
| board_id | string | yes | Unique identifier (ID) of the board from which you want to retrieve a list of connectors. |

### Create connector
`POST https://www.apizie.tech/v1/business:miro/create-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board for which you want to create the connector. |
| body | object | yes | JSON request body |

### Get specific connector
`GET https://www.apizie.tech/v1/business:miro/get-connector` (byok)

| Parameter | 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. |

### Update connector
`POST https://www.apizie.tech/v1/business:miro/update-connector` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete connector
`POST https://www.apizie.tech/v1/business:miro/delete-connector` (byok)

| Parameter | 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. |

### Create document item using URL
`POST https://www.apizie.tech/v1/business:miro/create-document-item-using-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get document item
`GET https://www.apizie.tech/v1/business:miro/get-document-item` (byok)

| Parameter | 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. |

### Update document item using URL
`POST https://www.apizie.tech/v1/business:miro/update-document-item-using-url` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete document item
`POST https://www.apizie.tech/v1/business:miro/delete-document-item` (byok)

| Parameter | 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. |

### Create embed item
`POST https://www.apizie.tech/v1/business:miro/create-embed-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get embed item
`GET https://www.apizie.tech/v1/business:miro/get-embed-item` (byok)

| Parameter | 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. |

### Update embed item
`POST https://www.apizie.tech/v1/business:miro/update-embed-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete embed item
`POST https://www.apizie.tech/v1/business:miro/delete-embed-item` (byok)

| Parameter | 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. |

### Create image item using URL
`POST https://www.apizie.tech/v1/business:miro/create-image-item-using-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get image item
`GET https://www.apizie.tech/v1/business:miro/get-image-item` (byok)

| Parameter | 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. |

### Update image item using URL
`POST https://www.apizie.tech/v1/business:miro/update-image-item-using-url` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete image item
`POST https://www.apizie.tech/v1/business:miro/delete-image-item` (byok)

| Parameter | 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. |

### Get items on board
`GET https://www.apizie.tech/v1/business:miro/get-items` (byok)

| Parameter | 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… |
| 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,… |
| 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… |
| board_id | string | yes | Unique identifier (ID) of the board for which you want to retrieve the list of available items. |

### Get specific item on board
`GET https://www.apizie.tech/v1/business:miro/get-specific-item` (byok)

| Parameter | 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. |

### Update item position or parent
`POST https://www.apizie.tech/v1/business:miro/update-item-position-or-parent` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete item
`POST https://www.apizie.tech/v1/business:miro/delete-item` (byok)

| Parameter | 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. |

### Get all board members
`GET https://www.apizie.tech/v1/business:miro/get-board-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | The maximum number of board members to retrieve. Default: `20`. |
| 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. |

### Share board
`POST https://www.apizie.tech/v1/business:miro/share-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board to which the board member belongs. |
| body | object | yes | JSON request body |

### Get specific board member
`GET https://www.apizie.tech/v1/business:miro/get-specific-board-member` (byok)

| Parameter | 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. |

### Update board member
`POST https://www.apizie.tech/v1/business:miro/update-board-member` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Remove board member
`POST https://www.apizie.tech/v1/business:miro/remove-board-member` (byok)

| Parameter | 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. |

### Create shape item
`POST https://www.apizie.tech/v1/business:miro/create-shape-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get shape item
`GET https://www.apizie.tech/v1/business:miro/get-shape-item` (byok)

| Parameter | 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. |

### Update shape item
`POST https://www.apizie.tech/v1/business:miro/update-shape-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete shape item
`POST https://www.apizie.tech/v1/business:miro/delete-shape-item` (byok)

| Parameter | 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. |

### Create sticky note item
`POST https://www.apizie.tech/v1/business:miro/create-sticky-note-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get sticky note item
`GET https://www.apizie.tech/v1/business:miro/get-sticky-note-item` (byok)

| Parameter | 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. |

### Update sticky note item
`POST https://www.apizie.tech/v1/business:miro/update-sticky-note-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete sticky note item
`POST https://www.apizie.tech/v1/business:miro/delete-sticky-note-item` (byok)

| Parameter | 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. |

### Create text item
`POST https://www.apizie.tech/v1/business:miro/create-text-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get text item
`GET https://www.apizie.tech/v1/business:miro/get-text-item` (byok)

| Parameter | 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. |

### Update text item
`POST https://www.apizie.tech/v1/business:miro/update-text-item` (byok)

| Parameter | 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. |
| body | object | yes | JSON request body |

### Delete text item
`POST https://www.apizie.tech/v1/business:miro/delete-text-item` (byok)

| Parameter | 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. |

### Create items in bulk
`POST https://www.apizie.tech/v1/business:miro/create-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Create frame
`POST https://www.apizie.tech/v1/business:miro/create-frame-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create a frame. |
| body | object | yes | JSON request body |

### Get frame
`GET https://www.apizie.tech/v1/business:miro/get-frame-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board that contains the frame that you want to retrieve |
| item_id | string | yes | Unique identifier (ID) of the frame that you want to retrieve. |

### Update frame
`POST https://www.apizie.tech/v1/business:miro/update-frame-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to update the frame. |
| item_id | string | yes | Unique identifier (ID) of the frame that you want to update. |
| body | object | yes | JSON request body |

### Delete frame
`POST https://www.apizie.tech/v1/business:miro/delete-frame-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board from which you want to delete the frame. |
| item_id | string | yes | Unique identifier (ID) of the frame that you want to delete. |

### Get items within frame
`GET https://www.apizie.tech/v1/business:miro/get-items-within-frame` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id_PlatformContainers | string | yes | Unique identifier (ID) of the board that contains the frame for which you want to retrieve the list of available items. |
| parent_item_id | string | yes | ID of the frame for which you want to retrieve the list of available items. |
| 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… |
| 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,… |
| 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… |

### Create items in bulk using file from device
`POST https://www.apizie.tech/v1/business:miro/create-items-in-bulk-using-file-from-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| board_id_Platformcreateitemsinbulkusingfilefromdevice | string | yes | Path parameter {board_id_Platformcreateitemsinbulkusingfilefromdevice} |
| body | object | yes | Form fields as a JSON object |

### Get app metrics
`GET https://www.apizie.tech/v1/business:miro/get-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | ID of the app to get metrics for. |
| startDate | string | yes | Start date of the period in UTC format. For example, 2024-12-31. |
| endDate | string | yes | End date of the period in UTC format. For example, 2024-12-31. |
| period | string | no | Group data by this time period. |

### Get total app metrics
`GET https://www.apizie.tech/v1/business:miro/get-metrics-total` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | ID of the app to get total metrics for. |

### Get specific mind map node
`GET https://www.apizie.tech/v1/business:miro/get-mindmap-node-experimental` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board from which you want to retrieve a mind map node. |
| item_id | string | yes | Unique identifier (ID) of the mind map node that you want to retrieve. |

### Delete mind map node
`POST https://www.apizie.tech/v1/business:miro/delete-mindmap-node-experimental` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board from which you want to delete the mind map node. |
| item_id | string | yes | Unique identifier (ID) of the mind map node that you want to delete. |

### Get mind map nodes
`GET https://www.apizie.tech/v1/business:miro/get-mindmap-nodes-experimental` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board from which you want to retrieve mind map nodes. |
| limit | string | no | Maximum number of results returned |
| cursor | string | no | Points to the next portion of the results set |

### Create mind map node
`POST https://www.apizie.tech/v1/business:miro/create-mindmap-nodes-experimental` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get items on board
`GET https://www.apizie.tech/v1/business:miro/get-items-experimental` (byok)

| Parameter | 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… |
| type | string | no |  |
| 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… |
| board_id | string | yes | Unique identifier (ID) of the board for which you want to retrieve the list of available items. |

### Get specific item on board
`GET https://www.apizie.tech/v1/business:miro/get-specific-item-experimental` (byok)

| Parameter | 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. |

### Delete item
`POST https://www.apizie.tech/v1/business:miro/delete-item-experimental` (byok)

| Parameter | 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. |

### Create shape item
`POST https://www.apizie.tech/v1/business:miro/create-shape-item-flowchart` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| board_id | string | yes | Unique identifier (ID) of the board where you want to create the item. |
| body | object | yes | JSON request body |

### Get shape item
`GET https://www.apizie.tech/v1/business:miro/get-shape-item-flowchart` (byok)

| Parameter | 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. |

…and 76 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/business:miro/token-info" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Miro Developer Platform API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/business:miro/token-info with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Miro Developer Platform API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Miro Developer Platform itself also needs your own key from miro.

### Can AI agents use the Miro Developer Platform API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:miro.

### What is the status of the Miro Developer Platform API?
Needs your own provider key (bring your own key)