List the document tree

GET/v1/workspaces/{workspaceId}/tree

Lists documents depth-first in tree order. With rootId, lists that document's descendants only.

Request

curl "https://api.lydie.co/v1/workspaces/01JCQ3TZ0WJ8K4M2X7T9R6N1PA/tree" \
  -H "Authorization: Bearer $LYDIE_TOKEN"

Path parameters

workspaceIdstringrequired· 1–64 chars

Query parameters

rootIdULID
includeDeletedboolean
Default false

Response

entriesTreeEntry[]
Show 14 fieldsHide fields
- idULID
- workspaceIdstring· 1–64 chars
- parentIdULIDor null
- titlestring· 1–255 chars
- sortKeystring· 1–256 chars
- propertiesobject
- createdAttimestamp
- updatedAttimestamp
- deletedAttimestampor null
- createdBystringor nulloptional· ≥ 1 chars
- updatedBystringor nulloptional· ≥ 1 chars
- depthinteger
  0 for the top level of the listed tree.
- teamspaceIdstringor nulloptional
- privateOwnerIdstringor nulloptional

200

{
  "entries": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "parentId": null,
      "title": "Meeting notes",
      "sortKey": "a0",
      "properties": {
        "status": "draft"
      },
      "createdAt": "2026-11-12T09:30:00.000Z",
      "updatedAt": "2026-11-12T09:30:00.000Z",
      "deletedAt": null,
      "createdBy": null,
      "updatedBy": null,
      "depth": 0,
      "teamspaceId": null,
      "privateOwnerId": null
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.