Skip to main content
GET
Get a comparison

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

matterId
string
required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

comparisonId
string
required

cmp_ identifier of the comparison. Returned on the operation that launched it.

Response

Successful Response

One comparison. status is the public five, never the stored spelling.

id
string
required

Public identifier, cmp_ followed by 32 hex characters.

Example:

"cmp_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

matterId
string
required

mat_ identifier of the matter this comparison belongs to.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

title
string
required

Display title for the comparison.

Example:

"MSA v2 against v3"

status
enum<string>
required

Comparison status, using the same five public values as an operation. Hunks are only complete once this is succeeded.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"succeeded"

original
ComparisonSource · object
required

The original side, as resolved at launch.

revised
ComparisonSource · object
required

The revised side, as resolved at launch.

settings
ComparisonSettings · object
required

The settings this comparison actually ran with.

hunkCount
integer
required

Total structural changes found, cosmetic ones included.

Example:

37

substantiveCount
integer
required

Changes the engine judged substantive rather than cosmetic. This is the number a reviewer actually has to look at.

Example:

12

createdAt
string<date-time>
required

When the comparison was created (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

updatedAt
string<date-time>
required

When the comparison was last updated (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

summary
string | null

Prose summary of what changed. Absent until the comparison succeeds.

Example:

"Twelve substantive changes, seven of them in the liability and indemnity sections."

summaryBullets
string[] | null

The same summary as discrete points, for rendering as a list.

Example:
Last modified on August 23, 2026