---
title: "Document Contents"
method: GET
path: "/v1/documents/{id}/contents"
tags: ["Document Access"]
---

# Document Contents

`GET /v1/documents/{id}/contents`

Retrieves information about the contents of the requested Lucidchart or Lucidspark document.

Due to the evolving nature of Lucid documents, an unchanged document may produce varying results over time.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK with Document Content resource containing information about the requested document's content.

- DocumentContent — Object representing the contents of a Lucidchart document
  - `id` string, uuid, required — Document ID
  - `title` string, required — Title of the document
  - `product` 'lucidchart' | 'lucidscale' | 'lucidspark', required — The Lucid Suite product that a document was created in.
  - `pages` Page[], required — Array of Page resources on the document
    - `id` string, required — Page ID
    - `title` string, required — Title of the page
    - `index` integer, required — 0-Based index of the page in the document
    - `items` Items, required — Individual shapes, lines, groups, and layers all contain a unique ItemId identifying the object.
      - `shapes` Shape[], required — Array of Shape resources
        - `id` string, required — Shape ID
        - `class` string, required — A unique string representing the type of the shape (e.g., ProcessBlock)
        - `textAreas` TextArea[], required
          - `label` string, required — Text area label
          - `text` string, required — Text displayed in the text area. This is plain text. All formatting has been removed & formulas evaluated.
        - `customData` DataPair[], required
          - `name` string, required — Custom data key
          - `value` string, required — Custom data value
        - `linkedData` LinkedData[], required
          - `collection_id` string — Id of the collection containing the data
          - `data` DataPair[], required — Key-value pairs from the dataset
            - `name` string, required — Custom data key
            - `value` string, required — Custom data value
          - `primaryKeyValue` string, required — The value of the primary key of the dataset
        - `contains` Contains — Object listing the IDs of items contained within a container shape (e.g., a frame).
          - `shapes` string[], required — Array of IDs of shapes contained within the container
          - `lines` string[], required — Array of IDs of lines contained within the container
          - `groups` string[], required — Array of IDs of groups contained within the container
      - `lines` Line[], required — Array of Line resources
        - `id` string, required — Line ID
        - `endpoint1` Endpoint, required — Object representing the endpoint of a Line.
          - `style` string, required — Line end style
          - `connectedTo` string, nullable, required — Id of shape or line the line is connected to
        - `endpoint2` Endpoint, required — Object representing the endpoint of a Line.
          - `style` string, required — Line end style
          - `connectedTo` string, nullable, required — Id of shape or line the line is connected to
        - `textAreas` TextArea[], required
          - `label` string, required — Text area label
          - `text` string, required — Text displayed in the text area. This is plain text. All formatting has been removed & formulas evaluated.
        - `customData` DataPair[], required
          - `name` string, required — Custom data key
          - `value` string, required — Custom data value
        - `linkedData` LinkedData[], required
          - `collection_id` string — Id of the collection containing the data
          - `data` DataPair[], required — Key-value pairs from the dataset
            - `name` string, required — Custom data key
            - `value` string, required — Custom data value
          - `primaryKeyValue` string, required — The value of the primary key of the dataset
      - `groups` Group[], required — Array of Group resources
        - `id` string, required — Group ID
        - `members` string[], required — Array of IDs of shapes, lines, & groups contained within the group
        - `customData` DataPair[]
          - `name` string, required — Custom data key
          - `value` string, required — Custom data value
        - `linkedData` LinkedData[]
          - `collection_id` string — Id of the collection containing the data
          - `data` DataPair[], required — Key-value pairs from the dataset
            - `name` string, required — Custom data key
            - `value` string, required — Custom data value
          - `primaryKeyValue` string, required — The value of the primary key of the dataset
      - `layers` Layer[], required — Array of Layer resources
        - `id` string, required — Layer ID
        - `name` string, required — The name of the layer
        - `members` string[], required — Array of IDs of shapes, lines, & groups contained within the layer
        - `customData` DataPair[], required
          - `name` string, required — Custom data key
          - `value` string, required — Custom data value
        - `linkedData` LinkedData[], required
          - `collection_id` string — Id of the collection containing the data
          - `data` DataPair[], required — Key-value pairs from the dataset
            - `name` string, required — Custom data key
            - `value` string, required — Custom data value
          - `primaryKeyValue` string, required — The value of the primary key of the dataset
    - `customData` DataPair[], required — Array of Data Pair resources linked to the page
      - `name` string, required — Custom data key
      - `value` string, required — Custom data value
    - `linkedData` LinkedData[], required — Array of Linked Data resources linked to the page
      - `collection_id` string — Id of the collection containing the data
      - `data` DataPair[], required — Key-value pairs from the dataset
        - `name` string, required — Custom data key
        - `value` string, required — Custom data value
      - `primaryKeyValue` string, required — The value of the primary key of the dataset
  - `accountId` integer, required — ID of Lucid account that owns the document
  - `data` Data, required — Object representing an array of Collections on a document.
    - `collections` Collection[], required — Array of collections
      - `id` string, required — Id of the collection
      - `name` string, required — Collection name
      - `primaryKey` string[], required — The primary key column name

## Other responses

- `403` — Forbidden if the app making the request does not have permission to the document, or if the document has been deleted or does not exist.
- `429` — Too Many Requests if the account makes more than 100 requests in 5 seconds.

---

[API](https://skmtc.net/lucid/apis/lucid-rest-api.md) · [All operations](https://skmtc.net/lucid/apis/lucid-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lucid/lucid-rest-api/revisions/6a32cb9e1aa7/schema)