Document Contents Resource

The Document Content resource is returned by the Get Document Contents endpoint. It provides a structured representation of everything inside a document: its pages, the shapes and lines on each page, groups, layers, text, custom data, and any linked dataset records.

DocumentContent

The root response object.

Example

{
  "id": "8e7b19ec-27ff-40e3-beb8-03f51b1661b2",
  "title": "document title",
  "product": "lucidchart",
  "accountId": 1234,
  "pages": [],
  "data": {
    "collections": []
  }
}

Product

A string enum identifying which Lucid product the document belongs to.

Possible values: lucidchart, lucidscale, lucidspark

Page

A single page within the document.

Example

{
  "id": "YGcM5DNywbTK",
  "title": "document page title",
  "index": 0,
  "items": {
    "shapes": [],
    "lines": [],
    "groups": [],
    "layers": []
  },
  "customData": [],
  "linkedData": []
}

Items

The collection of all drawable items on a page. Item IDs are unique across shapes, lines, and groups within a document.

Shape

A shape placed on a page. A shape's id is unique across all shapes, lines, and groups in the document.

Line

A line connecting shapes on a page. A line's id is unique across all shapes, lines, and groups in the document.

Group

A named grouping of shapes, lines, and other groups on a page. A group's id is unique across all shapes, lines, and groups in the document.

Layer

A layer organizes items on a page. Layers can be shown or hidden in the Lucid editor.

Endpoint

One end of a line.

TextArea

A labeled block of text on a shape or line. Text is returned as plain text — all formatting has been stripped and any formulas have been evaluated.

Contains

Lists the IDs of items nested inside a container shape (e.g., a frame).

Data

The structured data embedded on the document, organized into collections.

Collection

A collection is a container for structured data within a document — analogous to a tab or individual sheet in a spreadsheet. A collection belongs to exactly one data source.

DataPair

A key-value pair of custom data. Custom data can be attached to pages, shapes, lines, groups, and layers.

Example

{
  "name": "City",
  "value": "New York"
}

LinkedData

Data from a document collection that has been linked to a specific page, shape, line, group, or layer.