2025-05-20

The GET Items endpoint for the REST API now returns read-only details for structured documents (doc_format) on a Miro board (see Docs in Miro).

With support for structured documents (doc_format) in the GET Items endpoint, we've introduced a new corresponding value in the API:

• A new type, "doc_format", which refers to structured documents

In addition to this new value in the GET Items API, position details for individual items returned by our REST APIs now include a unique ID for items that are embedded within a structured document:

• For items embedded within a structured document, the corresponding position object returned by the API for that item now includes a new "slotId" field, reflecting where the item fits in to the structured document.
• The position of items embedded in a structured document will be determined by "slotId". Each embedded item in a structured document will have an "" artifact in the HTML content of the structured document.
• Children items of a structured document (embedded items) will have the corresponding "parent.id" value for the item ID of the structured document item (doc).

Note:
Structured documents of type "doc_format" do not replace the existing "document" type for items. "doc_format" refers uniquely to structured documents that are editable from a Miro board (see Docs in Miro), while "document" continues to refer to documents such as PDFs that have been uploaded to a Miro board via URL.