Get Tracking Changes in Word
Generate → Get Tracking Changes in Word
The Get Tracking Changes in Word API extracts tracking-changes information from a Word document. You send the document as Base64 (docContent), docName, and optionally async. The API returns JSON with all revisions, comments, and changes. Use the tester below to try it; more details are in the sections that follow.
Try the Get Tracking Changes in Word API
:::note Quick reference
Endpoint: POST /api/v2/GetTrackingChangesInWord · Required: api-key, docName, docContent
:::
:::info Try it live Use the form below to send your API key and Word document (Base64) that has tracking changes. The response is JSON with revisions, comments, and changes. No code required—fill the fields and click Send request. :::
Overview, parameters, and use cases
- Overview
- Parameters
- Use cases
What is Get Tracking Changes in Word?
This endpoint extracts tracking-changes information from a Word document (.doc, .docx). You provide the document (Base64) and output name; the API returns JSON with all revisions, comments, and changes (insertions, deletions, formatting). Use it to read the revision history or feed it into review workflows.
Key features
- Revisions and comments – Returns JSON with all revisions, comments, and changes.
- Single document – docContent (Base64), docName (e.g. output.docx).
- Async – Use async for large or heavily revised documents.
:::tip Best for Use when you need to read or process the revision history of a Word document. Pair with Enable Tracking Changes in Word and Disable Tracking Changes in Word for full review workflows. :::
When to use Get Tracking Changes in Word
- Review summaries – Extract all revisions and comments for display or reporting.
- Workflow automation – Read tracking data to approve, reject, or route changes.
- Audit – Get a structured record of edits for compliance or history.
:::info Need the full API? For request/response schemas and code samples, see Get Tracking Changes in Word in the PDF4me API docs. :::
Prerequisites
Before using this endpoint, make sure you have:
- A valid PDF4me API key (Get your API Key)
- A Word document with tracking changes in Base64 format
Response Format
The API returns JSON text with tracking changes information for synchronous processing (200 OK) or provides a polling URL for asynchronous processing (202 Accepted).