API ReferenceWorkflows

Diff a draft against the current workflow

Returns a structured diff between the draft and the currently serving workflow version — counts of added/removed/changed policy nodes and a coarse classification (structural or patch) that the dashboard uses to pre-select the publish rollout percentage.

Required scope: workflows:read

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

workflow_idstringRequired
draft_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

Draft diff.
classificationenumOptional
live_versionintegerOptional
live_node_countintegerOptional
draft_node_countintegerOptional
added_nodeslist of stringsOptional
removed_nodeslist of stringsOptional
changed_nodeslist of stringsOptional

Errors

401
Unauthorized Error
404
Not Found Error