GetPdfAnnotationsResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-get-pdf-annotations-result-schema.json",
  "title": "GetPdfAnnotationsResult",
  "description": "Result of retrieving annotations from a PDF document",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-editpdf-api-openapi.yml#/components/schemas/GetPdfAnnotationsResult",
  "type": "object",
  "properties": {
    "Successful": {
      "description": "True if successful, false otherwise",
      "type": "boolean"
    },
    "Annotations": {
      "description": "Annotations in the PDF file, ordered by placement from start to finish in the document",
      "type": "array",
      "items": {
        "$ref": "#/$defs/PdfAnnotation"
      }
    }
  },
  "$defs": {
    "PdfAnnotation": {
      "description": "PDF Annotation details",
      "type": "object",
      "properties": {
        "Title": {
          "description": "Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files",
          "type": "string"
        },
        "AnnotationType": {
          "description": "Type of the annotation; possible values are Text",
          "type": "string"
        },
        "PageNumber": {
          "format": "int32",
          "description": "The 1-based index of the page containing the annotation",
          "type": "integer"
        },
        "AnnotationIndex": {
          "format": "int32",
          "description": "The 0-based index of the annotation in the document",
          "type": "integer"
        },
        "Subject": {
          "description": "Subject of the annotation",
          "type": "string"
        },
        "TextContents": {
          "description": "Text contents of the annotation",
          "type": "string"
        },
        "CreationDate": {
          "format": "date-time",
          "description": "Date that the annotation was created",
          "type": "string"
        },
        "ModifiedDate": {
          "format": "date-time",
          "description": "Date that the annotation was last modified",
          "type": "string"
        },
        "LeftX": {
          "format": "double",
          "description": "Left X coordinate for the location of the annotation",
          "type": "number"
        },
        "TopY": {
          "format": "double",
          "description": "Top Y coordination of the location of the annotation",
          "type": "number"
        },
        "Width": {
          "format": "double",
          "description": "Width of the annotation",
          "type": "number"
        },
        "Height": {
          "format": "double",
          "description": "Height of the annotation",
          "type": "number"
        }
      }
    }
  }
}