get.mdx

title	trackChanges.get
sidebarTitle	trackChanges.get
description	Retrieve a single tracked change by ID.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via pnpm run docapi:sync. */}

Summary

Retrieve a single tracked change by ID.

• Operation ID: trackChanges.get
• API member path: editor.doc.trackChanges.get(...)
• Mutates document: no
• Idempotency: idempotent
• Supports tracked mode: no
• Supports dry run: no
• Deterministic target resolution: yes

Expected result

Returns a TrackChangeInfo object with the change type (insert, delete, replacement, format, structural), author, date, affected content, and raw imported Word OOXML revision IDs (w:id) when available. Structural changes (whole-table insert/delete) carry a subtype of table-insert or table-delete.

Input fields

Field	Type	Required	Description
id	string	yes
story	StoryLocator	no	StoryLocator

Example request

{
  "id": "id-001",
  "story": {
    "kind": "story",
    "storyType": "body"
  }
}

Output fields

Field	Type	Required	Description
address	TrackedChangeAddress	yes	TrackedChangeAddress
address.entityId	string	yes
address.entityType	"trackedChange"	yes	Constant: "trackedChange"
address.kind	"entity"	yes	Constant: "entity"
address.story	StoryLocator	no	StoryLocator
author	string	no
authorEmail	string	no
authorImage	string	no
date	string	no
deletedText	string	no
excerpt	string	no
grouping	enum	no	"standalone", "replacement-pair", "unknown"
id	string	yes
insertedText	string	no
pairedWithChangeId	string | null	no
subtype	enum	no	"table-insert", "table-delete"
type	enum	yes	"insert", "delete", "replacement", "format", "structural"
wordRevisionIds	object	no
wordRevisionIds.delete	string	no
wordRevisionIds.format	string	no
wordRevisionIds.insert	string	no

Example response

{
  "address": {
    "entityId": "entity-789",
    "entityType": "trackedChange",
    "kind": "entity",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  },
  "grouping": "standalone",
  "id": "id-001",
  "subtype": "table-insert",
  "type": "insert"
}

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

```json { "additionalProperties": false, "properties": { "id": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "required": [ "id" ], "type": "object" } ``` ```json { "additionalProperties": false, "properties": { "address": { "$ref": "#/$defs/TrackedChangeAddress" }, "author": { "type": "string" }, "authorEmail": { "type": "string" }, "authorImage": { "type": "string" }, "date": { "type": "string" }, "deletedText": { "type": "string" }, "excerpt": { "type": "string" }, "grouping": { "enum": [ "standalone", "replacement-pair", "unknown" ] }, "id": { "type": "string" }, "insertedText": { "type": "string" }, "pairedWithChangeId": { "type": [ "string", "null" ] }, "subtype": { "description": "Finer classification for structural changes (type === 'structural').", "enum": [ "table-insert", "table-delete" ] }, "type": { "enum": [ "insert", "delete", "replacement", "format", "structural" ] }, "wordRevisionIds": { "additionalProperties": false, "description": "Raw imported Word OOXML revision IDs (`w:id`) from the source document when available. This is provenance metadata, not the canonical SuperDoc tracked-change ID. Replacements may include both `insert` and `delete` IDs.", "properties": { "delete": { "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a deletion.", "type": "string" }, "format": { "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a formatting revision.", "type": "string" }, "insert": { "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes an insertion.", "type": "string" } }, "type": "object" } }, "required": [ "address", "id", "type" ], "type": "object" } ```