Document apiReferenceChanges

changes.list

List the change records this session retains, oldest first, with each change's actor, cause, provenance and affected blocks. Pass the returned cursor back as `after` to read only newer records; `waitMs` long-polls until at least one newer record exists.

read-onlyidempotent
await doc.changes.list(…)

Expected result

Returns a ChangesListResult with items (oldest to newest), a resume cursor, a truncated flag when records after `after` were evicted, the session identity state and whether the session is collaborative.

Inputs

afterstring

Cursor from a previous result. Omit to read from the oldest retained record.

limitinteger

Maximum number of records to return. Defaults to 100.

storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
blockIdstring

Matches the block or any block in its split/merge lineage.

actorIdstring
includeUpdateboolean

Include each record's base64 Yjs update. Defaults to false.

waitMsinteger

Wait up to this many milliseconds for at least one record after `after`. Defaults to 0.

Result

Output fields
itemsobject[]required
cursorstring | nullrequired
truncatedbooleanrequired
identity"configured" | "missing"required
collaborationbooleanrequired

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas