How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Miro groups API

The groups API from Miro — 4 operation(s) for groups.

Miro groups API is one of 51 APIs that Miro publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version v2.0.

Requests are made against a single base URL, https://api.miro.com/.

7 operations 4 paths 23 schemas 2 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.0
Base URL
https://api.miro.com/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Miro groups API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2AuthCode) using the authorizationCode flow, exposing 8 scopes.

  • oAuth2AuthCode — For more information, see https://developers.miro.com/reference/authorization-flow-for-expiring-tokens

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

groups 7
POST
/v2/boards/{board_id}/groups
Create group
createGroup 1 param body → 201400404429
GET
/v2/boards/{board_id}/groups
Get all groups on a board
get-all-groups 3 params → 200400404429
GET
/v2/boards/{board_id}/groups/items
Get items of a group by ID
getItemsByGroupId 4 params → 200400404429
GET
/v2/boards/{board_id}/groups/{group_id}
Get a group by its ID
getGroupById 2 params → 200400404429
DELETE
/v2/boards/{board_id}/groups/{group_id}
Ungroup items
unGroup 3 params → 204400404429
PUT
/v2/boards/{board_id}/groups/{group_id}
Updates a group with new items
updateGroup 2 params body → 200400404429
DELETE
/v2/boards/{board_id}/groups/{group_id}?
Deletes the group
deleteGroup 3 params → 204400404429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are GenericItem (10 properties), EmbedData (9 properties), ItemPagedResponse (7 properties), CustomField (6 properties). Each schema is shown below with its type and property counts.

Group
object
4 properties 3 required
CustomField
object
Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
6 properties
PageLinks
object
Contains pagination links for the collection.
5 properties
GenericItem
object
Contains the result data.
10 properties 2 required
Geometry
object
Contains geometrical information about the item, such as its width or height.
3 properties
GroupResponseShort
object
Contains the result data.
4 properties
ItemPagedResponse
object
7 properties
modifiedBy
object
Contains information about the user who last modified the item.
2 properties
StickyNoteData
object
Contains sticky note item data, such as the content or shape of the sticky note.
2 properties
ShapeData
object
Contains shape item data, such as the content or shape type of the shape.
2 properties
DocumentData
object
2 properties
CardData
object
Contains card item data, such as the title, description, due date, or assignee ID.
4 properties
GroupId
string
Unique identifier (ID) of the Group
WidgetDataOutput
object
Contains the item data, such as the item title, content, or description.
createdBy
object
Contains information about the user who created the item.
2 properties
Parent
object
Contains information about the parent frame for the item.
1 property
AppCardData
object
Contains app card item data, such as the title, description, or fields.
5 properties
TextData
object
Contains text item data, such as the title, content, or description. For more information on the JSON properties, see [Data](https://developers.miro.com/refere…
1 property 1 required
FrameData
object
Contains frame item data, such as the title, frame type, or frame format.
3 properties
EmbedData
object
9 properties
ImageData
object
2 properties
BoardId
string
[Unique identifier (ID) of the board](https://developers.miro.com/reference/board-model)
Position
object
Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

miro-groups-api-openapi.yml Raw ↑

Other APIs Miro publishes across the network.

Miro AI Interaction Logs API
Miro App card items API
Miro App metrics (experimental) API
Miro Audit Logs API
Miro Board classification: Board level API
Miro Board classification: Organization level API
Miro Board classification: Team level API
Miro Board Content Logs API
Miro Board Export API
Miro Board members API
Miro Boards API
Miro Bulk operations API
Where this information came from

This is an independent, third-party profile of Miro groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.