trackChanges.list

List all tracked changes in the document.

Summary

List all tracked changes in the document.

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

Expected result

Returns a TrackChangesListResult with tracked change entries (insert, delete, replacement, format), total count, and raw imported Word OOXML revision IDs (w:id) when available.

Input fields

Field	Type	Required	Description
in	StoryLocator | "all"	no	One of: StoryLocator, "all"
limit	integer	no
offset	integer	no
type	enum	no	"insert", "delete", "replacement", "format"

Example request

{
  "limit": 50,
  "offset": 0
}

Output fields

Field	Type	Required	Description
evaluatedRevision	string	yes
items	object[]	yes
page	PageInfo	yes	PageInfo
page.limit	integer	yes
page.offset	integer	yes
page.returned	integer	yes
total	integer	yes

Example response

{
  "evaluatedRevision": "rev-001",
  "items": [
    {
      "address": {
        "entityId": "entity-789",
        "entityType": "trackedChange",
        "kind": "entity",
        "story": {
          "kind": "story",
          "storyType": "body"
        }
      },
      "grouping": "standalone",
      "handle": {
        "ref": "handle:abc123",
        "refStability": "stable",
        "targetKind": "text"
      },
      "id": "id-001",
      "pairedWithChangeId": null,
      "type": "insert"
    }
  ],
  "page": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  },
  "total": 1
}

Pre-apply throws

• INVALID_INPUT

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "in": {
      "description": "Story scope. Omit for body only, pass a StoryLocator for a single story, or 'all' for body + every revision-capable non-body story.",
      "oneOf": [
        {
          "$ref": "#/$defs/StoryLocator"
        },
        {
          "const": "all"
        }
      ]
    },
    "limit": {
      "description": "Maximum number of tracked changes to return.",
      "type": "integer"
    },
    "offset": {
      "description": "Number of tracked changes to skip for pagination.",
      "type": "integer"
    },
    "type": {
      "description": "Filter by change type: 'insert', 'delete', 'replacement', or 'format'.",
      "enum": [
        "insert",
        "delete",
        "replacement",
        "format"
      ]
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "evaluatedRevision": {
      "type": "string"
    },
    "items": {
      "items": {
        "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"
            ]
          },
          "handle": {
            "$ref": "#/$defs/ResolvedHandle"
          },
          "id": {
            "type": "string"
          },
          "insertedText": {
            "type": "string"
          },
          "pairedWithChangeId": {
            "type": [
              "string",
              "null"
            ]
          },
          "type": {
            "enum": [
              "insert",
              "delete",
              "replacement",
              "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": [
          "id",
          "handle",
          "address",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "page": {
      "$ref": "#/$defs/PageInfo"
    },
    "total": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "evaluatedRevision",
    "total",
    "items",
    "page"
  ],
  "type": "object"
}