Scaffold
Start free
Contents

Return the most recent durable compare session

GET /documents/compare/current

Headers

  • Authorization string Required

    Bearer <session token>: the signed-in user’s Scaffold session token.

  • x-org-id string Required

Query parameters

  • offset integer
  • page_size integer
  • max_text_chars integer

Returns

  • objectKind string

    One of compare

  • compareId string
  • compare_id string
  • baseDocumentId string
  • compareDocumentId string
  • currentBaseDocumentId string
  • currentCompareDocumentId string
  • summary object
  • decisions object
  • unresolvedDifferenceIds string[]
  • differences object[]
    Show 12 fields
    • ordinal integer
    • differenceId string
    • kind string

      One of text insert delete formatting

    • baseBlockIndex any
    • compareBlockIndex any
    • baseText string

      The base paragraph's text (for a formatting difference, a preview such as "Run formatting in Base: …"), cut at max_text_chars.

    • compareText string
    • baseTextTruncated boolean
    • compareTextTruncated boolean
    • containsFormatting boolean
    • formattingChanges object[]

      For a formatting difference, each named property that changed. Empty for other kinds and for compare sessions created before this field existed.

      Show 3 fields
      • property string Required

        One of bold italic underline strike font_size font_name color highlight style alignment indentation spacing

      • base any

        A boolean for a toggle, a short readable string ("12pt", "Heading 2"), or null when unset.

      • compare any
    • changeIds string[]
  • offset integer
  • pageSize integer
  • returned integer
  • totalDifferences integer
  • hasMore boolean