Confluence · Schema

Comment

Represents a comment on a Confluence page or blog post.

CollaborationContent ManagementDocumentationKnowledge BaseWiki

Properties

Name	Type	Description
id	string	The unique identifier of the comment.
status	string	The current status of the comment.
title	string	The title of the comment (typically auto-generated).
blogPostId	string	The ID of the blog post the comment is on, if applicable.
pageId	string	The ID of the page the comment is on, if applicable.
parentCommentId	string	The ID of the parent comment, if this is a reply.
authorId	string	The Atlassian account ID of the comment author.
createdAt	string	The ISO 8601 timestamp when the comment was created.
resolutionStatus	string	Resolution status for inline comments.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Comment",
  "type": "object",
  "description": "Represents a comment on a Confluence page or blog post.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the comment."
    },
    "status": {
      "type": "string",
      "description": "The current status of the comment."
    },
    "title": {
      "type": "string",
      "description": "The title of the comment (typically auto-generated)."
    },
    "blogPostId": {
      "type": "string",
      "description": "The ID of the blog post the comment is on, if applicable."
    },
    "pageId": {
      "type": "string",
      "description": "The ID of the page the comment is on, if applicable."
    },
    "parentCommentId": {
      "type": "string",
      "description": "The ID of the parent comment, if this is a reply."
    },
    "authorId": {
      "type": "string",
      "description": "The Atlassian account ID of the comment author."
    },
    "createdAt": {
      "type": "string",
      "description": "The ISO 8601 timestamp when the comment was created."
    },
    "resolutionStatus": {
      "type": "string",
      "description": "Resolution status for inline comments."
    }
  }
}