Please use the new revoke endpoint /v2/oauth/revoke. This endpoint is considered vulnerable and deprecated due to access token passed publicly in the URL.
object.id field), \nfrom other Platform API endpoints (for example, [Get boards API](https://developers.miro.com/reference/get-boards)), \nor from Miro UI URLs (board ID and organization ID from the URLs).\n"
},
{
"name": "emails",
"value": "someone@domain.com,someoneelse@domain.com",
"type": "query",
"description": "Filters AI interaction logs using a list of user emails. Only AI interactions associated with the provided emails will be included in the response."
},
{
"name": "from",
"value": "2026-01-30T17:26:50Z",
"type": "query",
"description": "Start date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from - to time range are returned.\nFormat: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n"
},
{
"name": "to",
"value": "2036-03-30T17:26:50Z",
"type": "query",
"description": "End date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from - to time range are returned.\nFormat: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n"
},
{
"name": "cursor",
"value": "MTY2OTg4NTIwMDAwMHwxMjM=",
"type": "query",
"description": "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.\n"
},
{
"name": "limit",
"value": "100",
"type": "query",
"description": "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 returns the cursor parameter with a value.\n"
},
{
"name": "sorting",
"value": "asc",
"type": "query",
"description": "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 a descending date, specify `desc`.\n"
}
]
},
"docs": "Retrieves AI interaction logs for your organization. AI interaction logs capture user interactions with AI features in Miro. You can retrieve results for a specific time period. You can also filter results based on object IDs and the emails of users who interacted with AI features. Additionally, results can be paginated for easier viewing and processing.\nThis API is available only for Enterprise plan users. You can only use this endpoint if you have the rol"
}
]
},
{
"info": {
"name": "Board classification: Team level",
"type": "folder"
},
"items": [
{
"info": {
"name": "Bulk update boards classification",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
},
{
"name": "team_id",
"value": "3074457345618265000",
"type": "path",
"description": "id of the team"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates board classification for not-classified only or all boards in an existing team.
This API is available only for Enterprise plan users. You can only use this endpoint if you "
},
{
"info": {
"name": "Get team settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification-settings",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
},
{
"name": "team_id",
"value": "3074457345618265000",
"type": "path",
"description": "id of the team"
}
]
},
"docs": "Retrieves board classification settings for an existing team.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role "
},
{
"info": {
"name": "Update team settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/data-classification-settings",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
},
{
"name": "team_id",
"value": "3074457345618265000",
"type": "path",
"description": "id of the team"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates board classification settings for an existing team.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role o"
}
]
},
{
"info": {
"name": "Board classification: Board level",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get board classification",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classification",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
},
{
"name": "team_id",
"value": "3074457345618265000",
"type": "path",
"description": "id of the team"
},
{
"name": "board_id",
"value": "o9J_kzlUDmo=",
"type": "path",
"description": "Unique identifier of the board that you want to retrieve."
}
]
},
"docs": "Retrieves board classification for a board.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can req"
},
{
"info": {
"name": "Update board classification",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/boards/:board_id/data-classification",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
},
{
"name": "team_id",
"value": "3074457345618265000",
"type": "path",
"description": "id of the team"
},
{
"name": "board_id",
"value": "o9J_kzlUDmo=",
"type": "path",
"description": "Unique identifier of the board that you want to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates board classification for an existing board.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. Yo"
}
]
},
{
"info": {
"name": "doc formats",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create doc format item",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/boards/:board_id/docs",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier (ID) of the board where you want to create the item."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a doc format item to a board.
This API is available only for Enterprise plan users with the "
},
{
"info": {
"name": "Create case",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/orgs/:org_id/cases",
"params": [
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization in which you want to create a new case."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creating a case for legal hold is the first critical step in the eDiscovery process when litigation or an investigation is anticipated. One of the purposes of creating a case is that it acts as a container that allows admins to group multiple legal holds under one case. For more information, see our Help Center page on creating a case.
This API creates a new case in an organization.
This API is available only for Enterprise plan users with the Ente"
},
{
"info": {
"name": "Edit case",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.miro.com/v2/orgs/:org_id/cases/:case_id",
"params": [
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization for which you want to edit the case information."
},
{
"name": "case_id",
"value": "3074457345619012007",
"type": "path",
"description": "The ID of the case you want to edit."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Editing a case allows eDiscovery Admins to keep case details accurate and aligned with the evolving scope of a legal matter. As investigations progress, it may be necessary to update the case name or description to reflect changes in focus, terminology, or internal documentation standards. Since a case serves as the central container for one or more legal holds, keeping its information up to date helps ensure clarity, consistency, and easier navigation for all stakeholders involved in the legal "
},
{
"info": {
"name": "Close case",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.miro.com/v2/orgs/:org_id/cases/:case_id",
"params": [
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization in which you want to close a case."
},
{
"name": "case_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the case you want to close."
}
]
},
"docs": "Closing a case is the final stage in the eDiscovery process, marking the conclusion of a legal matter or investigation. You must ensure that all associated legal holds within the case are closed before closing the case. Closing a case will permanently delete it. For more information, see our Help Center page on closing a case.
This API closes a case in an organization.
This API is available only for Enterprise plan users with the Help Center page on adding a legal hold to a case.
This API creat"
},
{
"info": {
"name": "Get board export jobs of a case",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/cases/:case_id/export-jobs",
"params": [
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items in the result list."
},
{
"name": "cursor",
"value": "MTY2OTg4NTIwMDAwMHwxMjM=",
"type": "query",
"description": "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 it to the value returned in the cursor field of the previous request.\n"
},
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization for which you want to retrieve the list of export jobs within a case."
},
{
"name": "case_id",
"value": "3074457345619012007",
"type": "path",
"description": "The ID of the case for which you want to retrieve the list of export jobs."
}
]
},
"docs": "Retrieves board export jobs for a case.
This API is available only for Enterprise plan users with the Enterprise Guard ad"
},
{
"info": {
"name": "Get legal hold information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id",
"params": [
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization for which you want to retrieve the legal hold information."
},
{
"name": "case_id",
"value": "3074457345619012007",
"type": "path",
"description": "The ID of the case for which you want to retrieve the legal hold information."
},
{
"name": "legal_hold_id",
"value": "3074457345619013003",
"type": "path",
"description": "The ID of the legal hold you want to retrieve."
}
]
},
"docs": "Retrieves information about a legal hold within a case for an organization. Required scope
organization:cases:management
This API is available only for Enterprise plan users with the Help Center page on closing a legal hold."
},
{
"info": {
"name": "Get content items under legal hold",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/cases/:case_id/legal-holds/:legal_hold_id/content-items",
"params": [
{
"name": "org_id",
"value": "3074457345618265000",
"type": "path",
"description": "The ID of the organization for which you want to retrieve the list of content items under hold."
},
{
"name": "case_id",
"value": "3074457345619012007",
"type": "path",
"description": "The ID of the case for which you want to retrieve the list of content items under hold."
},
{
"name": "legal_hold_id",
"value": "3074457345619013003",
"type": "path",
"description": "The ID of the legal hold for which you want to retrieve the list of content items under hold."
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items in the result list."
},
{
"name": "cursor",
"value": "MTY2OTg4NTIwMDAwMHwxMjM=",
"type": "query",
"description": "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 it to the value returned in the cursor field of the previous request.\n"
}
]
},
"docs": "Once a legal hold is in place you can review or explore the preserved Miro boards to ensure that all relevant data is intact and ready for legal proceedings or investigations. For more information, see our Help Center page on reviewing boards under legal hold.
This API lists all content items under a specific legal hold in a case for an organization. Please verify that the le"
}
]
},
{
"info": {
"name": "Board Export",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get board export jobs list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the board export jobs that you want to retrieve, such as JOB_STATUS_CREATED, JOB_STATUS_IN_PROGRESS, JOB_STATUS_CANCELLED or JOB_STATUS_FINISHED."
},
{
"name": "creatorId",
"value": "1234567890,9876543210",
"type": "query",
"description": "Unique identifier of the board export job creator."
},
{
"name": "cursor",
"value": "87a1a375-cee6-43f2-8049-5c9b5b6b9069",
"type": "query",
"description": "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.\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "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 returns the cursor parameter with a value.\n"
}
]
},
"docs": "Retrieves the list of board export jobs based on the filters provided in the request.
This API is available only for Enterprise plan users. You can only use this endpoint if you h"
},
{
"info": {
"name": "Create board export job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "request_id",
"value": "92343229-c532-446d-b8cb-2f155bedb807",
"type": "query",
"description": "Unique identifier of the board export job."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an export job for one or more boards.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDis"
},
{
"info": {
"name": "Get board export job status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs/:job_id",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "job_id",
"value": "92343229-c532-446d-b8cb-2f155bedb807",
"type": "path",
"description": "Unique identifier of the board export job."
}
]
},
"docs": "Retrieves the status of the board export job.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDis"
},
{
"info": {
"name": "Get results for board export job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs/:job_id/results",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "job_id",
"value": "92343229-c532-446d-b8cb-2f155bedb807",
"type": "path",
"description": "Unique identifier of the job."
}
]
},
"docs": "Retrieves the result of the board export job. The response provides more information about the board export job, such as the S3 link to the files created.
This API is available only for Currently, only the cancellation of an ongoing export job is supported.
This API is available only for Enterprise plan users. You c"
},
{
"info": {
"name": "Get board export job tasks list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs/:job_id/tasks",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "job_id",
"value": "08ac2d88-c3a7-46a1-923d-b5fb88ff3fe2",
"type": "path",
"description": "Unique identifier of the board export job."
},
{
"name": "status",
"value": "TASK_STATUS_CREATED",
"type": "query",
"description": "Filters the list of board export tasks by their status. Accepts an array of statuses such as TASK_STATUS_CREATED, TASK_STATUS_CANCELLED, TASK_STATUS_SCHEDULED, TASK_STATUS_SUCCESS or TASK_STATUS_ERROR."
},
{
"name": "cursor",
"value": "87a1a375-cee6-43f2-8049-5c9b5b6b9069",
"type": "query",
"description": "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.\n"
},
{
"name": "limit",
"value": "50",
"type": "query",
"description": "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 returns the cursor parameter with a value.\n"
}
]
},
"docs": "Retrieves the list of tasks for the board export job.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin "
},
{
"info": {
"name": "Create task export link",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/orgs/:org_id/boards/export/jobs/:job_id/tasks/:task_id/export-link",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "job_id",
"value": "08ac2d88-c3a7-46a1-923d-b5fb88ff3fe2",
"type": "path",
"description": "Unique identifier of the board export job."
},
{
"name": "task_id",
"value": "9394a815-86ea-418c-8bfc-71772fdb692d",
"type": "path",
"description": "Unique identifier of the board export task."
}
]
},
"docs": "Creates a link to download the results of a board export task.
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Compa"
}
]
},
{
"info": {
"name": "Board Content Logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve content change logs of board items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/content-logs/items",
"params": [
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "Unique identifier of the organization."
},
{
"name": "board_ids",
"value": "o9J_kzlUDmo=,u8J_kllZmDk=",
"type": "query",
"description": "List of board IDs for which you want to retrieve the content logs."
},
{
"name": "emails",
"value": "someone@domain.com,someoneelse@domain.com",
"type": "query",
"description": "Filter content logs based on the list of emails of users who created, modified, or deleted the board item."
},
{
"name": "from",
"value": "2022-03-30T17:26:50Z",
"type": "query",
"description": "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 date duration.\nFormat: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n"
},
{
"name": "to",
"value": "2023-03-30T17:26:50Z",
"type": "query",
"description": "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 duration. Format: UTC, adheres to\n[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n"
},
{
"name": "cursor",
"value": "MTY2OTg4NTIwMDAwMHwxMjM=",
"type": "query",
"description": "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.\n"
},
{
"name": "limit",
"value": "1000",
"type": "query",
"description": "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 returns the cursor parameter with a value.\n"
},
{
"name": "sorting",
"value": "asc",
"type": "query",
"description": "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 sort by a descending modified date, specify `desc`.\n"
}
]
},
"docs": "Retrieves content changes for board items within your organization. Content changes are actions that users can perform on board items, such as updating a sticky note's text. You can retrieve results for a specific time period. You can also filter results based on the board IDs and the emails of users who created, modified, or deleted a board item. Additionally, results can be paginated for easier viewing and processing.\n
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can requ"
}
]
},
{
"info": {
"name": "Organization Members",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get organization members",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/orgs/:org_id/members",
"params": [
{
"name": "emails",
"value": "",
"type": "query"
},
{
"name": "role",
"value": "",
"type": "query"
},
{
"name": "license",
"value": "",
"type": "query"
},
{
"name": "active",
"value": "",
"type": "query"
},
{
"name": "cursor",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "org_id",
"value": "3074457345821141000",
"type": "path",
"description": "id of the organization"
}
]
},
"docs": "Retrieves organization members based on the organization ID and the cursor, or based on the user emails provided in the request.
This API is available only for Enterprise planRequired scope
organizations:read
This API is available only for Enterprise plan users. You can only use this endpoint if you have the r"
}
]
},
{
"info": {
"name": "Boards",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get boards",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.miro.com/v2/boards",
"params": [
{
"name": "team_id",
"value": "",
"type": "query"
},
{
"name": "project_id",
"value": "",
"type": "query"
},
{
"name": "query",
"value": "",
"type": "query"
},
{
"name": "owner",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
}
]
},
"docs": "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.\nCustomize 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.\n\nIf you're an Enterprise customer with Company Admin permissions:\n- Enable **Content Admin"
},
{
"info": {
"name": "Create board",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.miro.com/v2/boards",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a board with the specified name and sharing policies.
Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: [Attach tag to item](https://developers.miro.com/reference/attach-tag-to-item), [Remove tag from item](https://developers.miro.com/reference/remove-tag-from-item), [Delete tag](htt" }, { "info": { "name": "Delete tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/boards/:board_id/tags/:tag_id", "params": [ { "name": "board_id", "value": "", "type": "path", "description": "Unique identifier (ID) of the board where you want to delete a specific tag." }, { "name": "tag_id", "value": "", "type": "path", "description": "Unique identifier (ID) of the tag that you want to delete." } ] }, "docs": "Deletes the specified tag from the board. The tag is also removed from all cards and sticky notes on the board.Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: [Attach tag to item](https://developers.miro.com/reference/attach-tag-to-item), [Remove tag from item](https://developers.miro.com/reference/re" }, { "info": { "name": "Get items by tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/boards/:board_id_PlatformTags/items", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "board_id_PlatformTags", "value": "", "type": "path", "description": "Unique identifier (ID) of the board where you want to retrieve a specific tag." }, { "name": "tag_id", "value": "", "type": "query", "description": "Unique identifier (ID) of the tag that you want to retrieve." } ] }, "docs": "Retrieves all the items that have the specified tag.Required scope
boards:readRate limiting
Level 1
" }, { "info": { "name": "Attach tag to item", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/boards/:board_id_PlatformTags/items/:item_id", "params": [ { "name": "board_id_PlatformTags", "value": "", "type": "path", "description": "Unique identifier (ID) of the board with the item that you want to add a tag to." }, { "name": "item_id", "value": "", "type": "path", "description": "Unique identifier (ID) of the item to which you want to add a tag." }, { "name": "tag_id", "value": "", "type": "query", "description": "Unique identifier (ID) of the tag you want to add to the item." } ] }, "docs": "Attach an existing tag to the specified item. Card and sticky note items can have up to 8 tags.Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: [Remove tag from item](https://developers.miro.com/reference/remove-tag-from-item), [Update tag](https://developers.miro.com/reference/update-tag), [Delete t" }, { "info": { "name": "Remove tag from item", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/boards/:board_id_PlatformTags/items/:item_id", "params": [ { "name": "board_id_PlatformTags", "value": "", "type": "path", "description": "Unique identifier (ID) of the board with the item that you want to remove a tag from." }, { "name": "item_id", "value": "", "type": "path", "description": "Unique identifier (ID) of the item that you want to remove the tag from." }, { "name": "tag_id", "value": "", "type": "query", "description": "Unique identifier (ID) of the tag that you want to remove from the item." } ] }, "docs": "Removes the specified tag from the specified item. The tag still exists on the board.Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: [Attach tag to item](https://developers.miro.com/reference/attach-tag-to-item), [Update tag](https://developers.miro.com/reference/update-tag), [Delete tag](https://de" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "List of projects", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization from which you want to retrieve the list of available projects." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team from which you want to retrieve the list of available projects." }, { "name": "limit", "value": "100", "type": "query", "description": "The maximum number of results to return per call. If the number of projects in the response is greater than the limit specified, the response returns the cursor parameter with a value." }, { "name": "cursor", "value": "3074457345618265000", "type": "query", "description": "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 it to the value returned in the cursor field of the previous request." } ] }, "docs": "Retrieves the list of projects in an existing team of an organization. You can retrieve all projects, including all private projects (projects that haven't been specifically shared with you) by enabling Content Admin permissions. To enable Content Admin permissions, see [Content Admin permissions for Company Admins](https://help.miro.com/hc/en-us/articles/360012777280-Content-Admin-permissions-for-Company-Admins).Note
Projects have been renamed to Spaces, and the terms" }, { "info": { "name": "Create project", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization within which you you want to create a project." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team within which you you want to create a project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects are essentially folders of boards with the option to manage user access for a smaller group of people within a team. Projects are here to help you organize your boards and make them easier to find and share. In other words, a project is a group of boards that you can share with your teammates all at once. For more information, see our Help Center page on Projects.
This API creates a new pro" }, { "info": { "name": "Get project", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects/:project_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization from which you want to retrieve the project information." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team from which you want to retrieve the project information." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project for which you want to retrieve the information." } ] }, "docs": "Retrieves project information, such as a name for an existing project.Note
Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope
projects:readRate limiting
Level 1Enterprise only
This API is available only for Note Projects have been renamed to Spaces, and the terms can be used interchangeably.
Required scope
projects:writeRate limiting
Level 1Enterprise only
This API is available only for Note Projects have been renamed to Spaces, and the terms can be used interchangeably.
Required scope
projects:writeRate limiting
Level 4Enterprise only
This API is available onl" } ] }, { "info": { "name": "Project Settings", "type": "folder" }, "items": [ { "info": { "name": "Get project settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects/:project_id/settings", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization to which the project belongs." }, { "name": "team_id", "value": "3074457345619012091", "type": "path", "description": "The ID of the team to which the project belongs." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project for which you want to retrieve the project settings." } ] }, "docs": "Retrieves the project settings.
Note
Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope
projects:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise pl" }, { "info": { "name": "Update project settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects/:project_id/settings", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization to which the project belongs." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team to which the project belongs." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project whose settings you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings of a project.
Note
Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope
projects:writeRate limiting
Level 1Enterprise only
This API is available only for Enterpris" } ] }, { "info": { "name": "Project Members", "type": "folder" }, "items": [ { "info": { "name": "List of project members", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization to which the project belongs." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team to which the project belongs." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project for which you want to retrieve the list of members." }, { "name": "limit", "value": "100", "type": "query", "description": "The maximum number of results to return per call. If the number of project members in the response is greater than the limit specified, the response returns the cursor parameter with a value." }, { "name": "cursor", "value": "3074457345618265000", "type": "query", "description": "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 it to the value returned in the cursor field of the previous request." } ] }, "docs": "Retrieves the list of members for a specific project.
Note
Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope
projects:readRate limiting
Level 1Enterprise only
This API is available only for Note Projects have been renamed to Spaces, and the terms can be used interchangeably.
Required scope
projects:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise pla" }, { "info": { "name": "Get project member", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members/:member_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the organization to which the project belongs." }, { "name": "team_id", "value": "3074457345619012000", "type": "path", "description": "The ID of the team to which the project belongs." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project from which you want to retrieve specific member information." }, { "name": "member_id", "value": "307445734562315000", "type": "path", "description": "The ID of the member for which you want to retrieve information." } ] }, "docs": "Retrieves information for a specific project member.
Note
Projects have been renamed to Spaces, and the terms can be used interchangeably.Required scope
projects:readRate limiting
Level 1Enterprise only
This API is available only for Note Projects have been renamed to Spaces, and the terms can be used interchangeably.
Required scope
projects:writeRate limiting
Level 1Enterprise only
This API is available only for Note Projects have been renamed to Spaces, and the terms can be used interchangeably.
Required scope
projects:writeRate limiting
Level 4Enterprise only
This API is available only for" } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "List teams", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "3055557345821140500", "type": "query", "description": "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 it to the value returned in the cursor field of the previous request." }, { "name": "name", "value": "My team", "type": "query", "description": "Name query. Filters teams by name using case insensitive partial match. A value \"dev\" will return both \"Developer's team\" and \"Team for developers\"." } ] }, "docs": "Retrieves list of teams in an existing organization.
Required scope
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Comp" }, { "info": { "name": "Create team", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/orgs/:org_id/teams", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new team in an existing organization.
Required scope
organizations:teams:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company " }, { "info": { "name": "Get team", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ] }, "docs": "Retrieves team information for an existing team.
Required scope
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company " }, { "info": { "name": "Update team", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing team.
Required scope
organizations:teams:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request" }, { "info": { "name": "Delete team", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ] }, "docs": "Deletes an existing team.
Required scope
organizations:teams:writeRate limiting
Level 4Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request" } ] }, { "info": { "name": "Team Members", "type": "folder" }, "items": [ { "info": { "name": "List team members", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "3055557345821140500", "type": "query", "description": "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 it to the value returned in the cursor field of the previous request." }, { "name": "role", "value": "", "type": "query", "description": "\nRole query. Filters members by role using full word match. Accepted values are:\n* \"member\": Team member with full member permissions.\n* \"admin\": Admin of a team. Team member with permission to manage team.\n* \"non_team\": External user, non-team user.\n* \"team_guest\": (Deprecated) Team-guest user, user with access only to a team without access to organization.\n" } ] }, "docs": "Retrieves team members by cursor.
Required scope
organizations:teams:readRate limiting
Level 2Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can " }, { "info": { "name": "Invite team members", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invites a new Miro user to an existing team. The user must exist in your Miro organization. Users who do not exist in your Miro organization can be invited to the team via [SCIM](https://developers.miro.com/docs/scim) and an external identity provider, such as Okta or Azure Active Directory.
Required scope
organizations:teams:writeRate limiting
Required scope
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can reque" }, { "info": { "name": "Update team member", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/members/:member_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." }, { "name": "member_id", "value": "3074457345618265000", "type": "path", "description": "The id of the Team Member" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates team member role in team by id.
Required scope
organizations:teams:writeRate limiting
Level 2Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. Y" }, { "info": { "name": "Delete team member from team", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/members/:member_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." }, { "name": "member_id", "value": "3074457345618265000", "type": "path", "description": "The id of the Team Member" } ] }, "docs": "Deletes team member from team by id.
Required scope
organizations:teams:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You " } ] }, { "info": { "name": "Team Settings", "type": "folder" }, "items": [ { "info": { "name": "Get default team settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/default_teams_settings", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The id of an Organization." } ] }, "docs": "Retrieves default team settings of an existing organization.
Required scope
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role o" }, { "info": { "name": "Get team settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/settings", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ] }, "docs": "Retrieves team settings of an existing team.
Required scope
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admi" }, { "info": { "name": "Update team settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/teams/:team_id/settings", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "team_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates team settings of an existing team.
Required scope
organizations:teams:writeRate limiting
Level 2Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin" } ] }, { "info": { "name": "User groups", "type": "folder" }, "items": [ { "info": { "name": "List of user groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/groups", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of user groups in the result list." }, { "name": "cursor", "value": "", "type": "query", "description": "A representation of the position of a user group in the full set of results. It is used to determine the first item of the resulting set. Leave empty to retrieve items from the beginning." } ] }, "docs": "Retrieves the list of user groups in an organization.
Required scope
organizations:groups:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Co" }, { "info": { "name": "Create user group", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/orgs/:org_id/groups", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user group in an organization.
Required scope
organizations:groups:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Ad" }, { "info": { "name": "Get user group", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." } ] }, "docs": "Retrieves a user group in an organization.
Required scope
organizations:groups:readRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin" }, { "info": { "name": "Update user group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user group in an organization.
Required scope
organizations:groups:writeRate limiting
Level 1Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin." }, { "info": { "name": "Delete user group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." } ] }, "docs": "Deletes a user group from an organization.
Required scope
organizations:groups:writeRate limiting
Level 4Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admi" } ] }, { "info": { "name": "User group members", "type": "folder" }, "items": [ { "info": { "name": "List of user group members", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of members in the result list." }, { "name": "cursor", "value": "", "type": "query", "description": "A representation of the position of a member in the full set of results. It is used to determine the first item of the resulting set. Leave empty to retrieve items from the beginning." } ] }, "docs": "Retrieves the list of members who are part of a team in an existing organization.
Required scope
organizations:groups:read
Rate limiting
Level 1
Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint" }, { "info": { "name": "Create user group member", "type": "http" }, "http": { "method": "POST", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a member to a user group in an organization.
Required scope
organizations:groups:write
Rate limiting
Level 1
Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Comp" }, { "info": { "name": "Bulk edit of membership in user group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/members", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add and remove members in one request. For example, remove user A and add user B. You can add or remove up to 500 users at a time.
Required scope
organizations:groups:write
Rate limiting
Level 1 per item. For example, if you want to add 10 users and remove 5, the rate limiting applicable will be 750 credits. This is because each " }, { "info": { "name": "Get user group member", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/members/:member_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." }, { "name": "member_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a group member." } ] }, "docs": "Retrieves information about a user group member in an organization.
Required scope
organizations:groups:read
Rate limiting
Level 1
Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have t" }, { "info": { "name": "Delete user group member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/members/:member_id", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." }, { "name": "member_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a group member." } ] }, "docs": "Removes a member from a user group in an organization.
Required scope
organizations:groups:write
Rate limiting
Level 4
Enterprise only
This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a" } ] }, { "info": { "name": "User group to teams", "type": "folder" }, "items": [ { "info": { "name": "Get teams of a user group", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/groups/:group_id/teams", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "group_id", "value": "3074457345618265000", "type": "path", "description": "The ID of a user group." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of teams in the result list." }, { "name": "cursor", "value": "", "type": "query", "description": "A representation of the position of a team in the full set of results. It is used to determine the first item of the resulting set. Leave empty to retrieve items from the beginning." } ] }, "docs": "Retrieves the list of teams that the user group is a part of.
Required scope
organizations:groups:read
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for
Required scope
organizations:groups:read
organizations:teams:readRate limiting
Level 1Enterprise only
This API is available only for
Required scope
organizations:groups:read
organizations:teams:readRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
organizations:teams:writeRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
organizations:teams:readRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
organizations:teams:writeRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
boards:readRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
boards:writeRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
boards:writeRate limiting
Level 1
Enterprise only
This API is available only for Enterp" } ] }, { "info": { "name": "Share projects with groups", "type": "folder" }, "items": [ { "info": { "name": "Get project user group assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.miro.com/v2/orgs/:org_id/projects/:project_id/groups", "params": [ { "name": "org_id", "value": "3074457345618265000", "type": "path", "description": "The ID of an organization." }, { "name": "project_id", "value": "3074457345618265000", "type": "path", "description": "The ID of the project." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of user groups in the result list." }, { "name": "cursor", "value": "", "type": "query", "description": "A representation of the position of a user group in the full set of results. It is used to determine the first item of the resulting set. Leave empty to retrieve items from the beginning." } ] }, "docs": "Retrieves information about user groups invited to the specified project.
Required scope
organizations:groups:read
projects:readRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
projects:writeRate limiting
Level 1
Enterprise only
This API is available only for
Required scope
organizations:groups:read
projects:writeRate limiting
Level 1
Enterprise only
This API is available only for En" } ] } ], "bundled": true }