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 doc formats API

The doc formats API from Miro — 2 operation(s) for doc formats.

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

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

This API exposes 3 operations across 2 paths, and defines 13 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/.

3 operations 2 paths 13 schemas 1 DELETE1 GET1 POST

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 doc formats 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 3

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

doc formats 3
POST
/v2/boards/{board_id}/docs
Create doc format item
create-doc-format-item 1 param body → 201400404429
GET
/v2/boards/{board_id}/docs/{item_id}
Get doc format item
get-doc-format-item 3 params → 200400404429
DELETE
/v2/boards/{board_id}/docs/{item_id}
Delete doc format item
delete-doc-format-item 2 params → 204400404429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are DocFormatItem (10 properties), Position (4 properties), DocFormatCreateRequest (3 properties), DocFormatMarkdownData (3 properties). Each schema is shown below with its type and property counts.

DocFormatCreateRequest
object
3 properties 1 required
DocFormatData
object
DocFormatMarkdownData
object
3 properties 2 required
DocFormatItem
object
10 properties 2 required
WidgetLinks
object
Contains applicable links for the item.
2 properties
PositionChange
object
Contains information about the item's position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.
2 properties
DocFormatHtmlData
object
3 properties 2 required
ParentLinksEnvelope
object
Contains information about the parent frame for the item.
2 properties
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
SelfLink
object
Contains applicable links for the current object.
1 property
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
modifiedBy
object
Contains information about the user who last modified the item.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

miro-doc-formats-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 doc formats 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.