Scaffold
Start free
Contents

List pending tracked revisions on a document working draft

GET /documents/{documentId}/revisions

Path parameters

  • documentId string Required

Headers

  • Authorization string Required

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

  • x-org-id string Required

Returns

  • document object

    A document/version summary, as returned by the read-oriented document routes (overview, revisions, content).

    Show 16 fields
    • id string
    • seriesId string
    • version integer
    • versionKind string

      One of original working_draft

    • parentDocumentId string | null
    • title string
    • mimeType string
    • purpose string

      One of source_doc playbook

    • description string
    • hasXml boolean
    • hasText boolean
    • sizeBytes integer
    • fileName string
    • contentSha256 string | null
    • createdAt string
    • updatedAt string
  • revisions object[]
    Show 7 fields
    • ordinal integer Required

      The change's position in document order.

    • change_id string Required

      The id to pass in accepted_change_ids or rejected_change_ids.

    • kind string Required

      insert and delete are text changes, paragraph_mark is an inserted or deleted paragraph mark (a paragraph split or join; it carries no text of its own), proposed is a Scaffold change marker, and the -prop-change kinds are tracked formatting or structure changes.

      One of insert delete paragraph_mark proposed r-prop-change p-prop-change tbl-prop-change tr-prop-change tc-prop-change sect-prop-change

    • author string | null
    • date string | null
    • text_preview string Required

      A short excerpt of the changed text.

    • justification string | null

      The reason recorded with the change, shown to the reviewer.

  • renderContentBase64 string | null
  • track object | null

    Null when the decisions store failed to load; the read still succeeds.

    Show 3 fields
    • items object[]
      Show 10 fields
      • id string Required
      • state string Required

        One of open in back

      • label string Required

        Positional label, e.g. "Change 3".

      • kind string | null
      • textPreview string
      • justification string | null

        Open entries only.

      • author string | null

        Present on both open and decided entries.

      • date string | null

        Open entries only.

      • decidedAt string

        Decided entries only.

      • decidedByUserId string | null

        Decided entries only.

    • hereId string | null

      Id of the first open entry, or null when nothing is open.

    • counts object
      Show 4 fields
      • open integer Required
      • in integer Required
      • back integer Required
      • total integer Required