Skip to main content
GET
Diff two Struct versions (or a version against the draft)
Draft versus last published version. Used by the builder before publish. Not billed.

Authorizations

Authorization
string
header
required

Organisation API key from Settings → API / /api/keys/. The secret is shown once. Send Authorization: Bearer sk-abacus-…. One active key per organisation. Ingest (/api/v2/ingest/*) refuses API keys — that surface is Auth0-only with ingest:read / ingest:write scopes.

Path Parameters

slug
string
required

Query Parameters

from
string
required

Diff source — either a published version number (integer >= 1) or the literal draft.

to
string
required

Diff target — either a published version number (integer >= 1) or the literal draft.

Response

Response shape for GET /structs/{slug}/diff/?from=&to=.

Compares two endpoints (each is a published version number or the literal "draft") and returns added / removed / modified / reordered field sets plus the full JSON bodies for client-side rendering.

diff_from
object
required

Compact {version, label} block describing one side of a diff.

diff_to
object
required

Compact {version, label} block describing one side of a diff.

added_fields
object[]
required
removed_fields
object[]
required
modified_fields
object[]
required
reordered_field_ids
string[]
required
annotation_changes
any[]
required
from_schema_json
any
required
to_schema_json
any
required