Skip to main content

​
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, author, date, affected content, and raw imported Word OOXML revision IDs (w:id) when available.

​
Input fields

FieldTypeRequiredDescription
idstringyes

​
Example request

{
  "id": "id-001"
}

​
Output fields

FieldTypeRequiredDescription
addressTrackedChangeAddressyesTrackedChangeAddress
address.entityIdstringyes
address.entityType"trackedChange"yesConstant: "trackedChange"
address.kind"entity"yesConstant: "entity"
authorstringno
authorEmailstringno
authorImagestringno
datestringno
excerptstringno
idstringyes
typeenumyes"insert", "delete", "format"
wordRevisionIdsobjectno
wordRevisionIds.deletestringno
wordRevisionIds.formatstringno
wordRevisionIds.insertstringno

​
Example response

{
  "address": {
    "entityId": "entity-789",
    "entityType": "trackedChange",
    "kind": "entity"
  },
  "author": "Jane Doe",
  "id": "id-001",
  "type": "insert",
  "wordRevisionIds": {
    "delete": "example",
    "insert": "example"
  }
}

​
Pre-apply throws

  • TARGET_NOT_FOUND

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/TrackedChangeAddress"
    },
    "author": {
      "type": "string"
    },
    "authorEmail": {
      "type": "string"
    },
    "authorImage": {
      "type": "string"
    },
    "date": {
      "type": "string"
    },
    "excerpt": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "enum": [
        "insert",
        "delete",
        "format"
      ]
    },
    "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 `<w:del>` element when this logical change includes a deletion.",
          "type": "string"
        },
        "format": {
          "description": "Raw imported Word OOXML revision ID (`w:id`) from a `<w:rPrChange>` element when this logical change includes a formatting revision.",
          "type": "string"
        },
        "insert": {
          "description": "Raw imported Word OOXML revision ID (`w:id`) from a `<w:ins>` element when this logical change includes an insertion.",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "address",
    "id",
    "type"
  ],
  "type": "object"
}