---
title: Get comment
slug: topic-api/get-comment
docTags: 
createdAt: 2024-06-10T16:49:07.009Z
---

{
  "id": "kkiQ_hvAJqu6ENgJXiqlc",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id}",
    "servers": [
      {
        "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id}"
      }
    ],
    "name": "Get comment",
    "description": "Get a single topic comment.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "topic-board-id",
          "type": "string",
          "example": "e18a2d10-1595-4e52-a941-22d43bf8d7ad",
          "description": "Id of the topic board"
        },
        {
          "kind": "required",
          "name": "topic-id",
          "type": "string",
          "example": "18d0273d-e15c-4924-97b3-6f47b233eebe",
          "description": "Topic id"
        },
        {
          "kind": "required",
          "name": "comment-id",
          "type": "string",
          "example": "b53a16c8-9ce7-4289-8b27-375e8810d360",
          "description": "Comment id"
        }
      ],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "includeAuthorization",
          "type": "boolean",
          "description": "Include authorization field in response"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "comment",
            "schema": [
              {
                "name": "guid",
                "kind": "optional",
                "type": "string",
                "description": "Represented as compacted UUID using 32 hexadecimal characters",
                "example": "b53a16c8-9ce7-4289-8b27-375e8810d360"
              },
              {
                "name": "date",
                "kind": "optional",
                "type": "string",
                "description": "Creation date of comment",
                "example": "2024-05-08T14:29:08.000+0000"
              },
              {
                "name": "author",
                "kind": "optional",
                "type": "string",
                "description": "User name of comment author",
                "example": "john@doe.com"
              },
              {
                "name": "comment",
                "kind": "optional",
                "type": "string",
                "description": "Text of the comment",
                "example": "Comment text"
              },
              {
                "name": "topic_guid",
                "kind": "optional",
                "type": "string",
                "description": "Id of the topic comment belongs to",
                "example": "18d0273d-e15c-4924-97b3-6f47b233eebe"
              },
              {
                "name": "modified_date",
                "kind": "optional",
                "type": "string",
                "description": "Last modified date of the comment",
                "example": "2024-05-08T15:29:08.000+0000"
              },
              {
                "name": "modified_author",
                "kind": "optional",
                "type": "string",
                "description": "User name of last user to modify the comment",
                "example": "john@doe.com"
              },
              {
                "name": "viewpoint_guid",
                "kind": "optional",
                "type": "string",
                "description": "Id of the associated viewpoint, useful for attaching an image to a comment",
                "example": "e765db1f-d705-4d6e-955c-28bf1a897818"
              },
              {
                "name": "authorization",
                "kind": "optional",
                "type": "object",
                "description": "Local variations from the global authorization defaults for this resource",
                "example": "",
                "schema": [
                  {
                    "name": "comment_actions",
                    "kind": "optional",
                    "type": "array",
                    "description": "List of comment actions",
                    "example": "[\"update\",\"delete\"]",
                    "itemType": "object",
                    "customType": "object[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/comment",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "b1tTrGRpGUkuLIg5m5ulO",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "ZuhN9kATL68IRkGx5MGaO",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "sSr5L1Zyztmo1sBgsvm63",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "SFDUJVf5smrbc2-bN-gA2",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/comments/{comment-id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "b1tTrGRpGUkuLIg5m5ulO"
    },
    "results": {
      "languages": [
        {
          "id": "nZF8h3OZTtcUGrwVCfTFy",
          "language": "200",
          "code": "// OK\n{\n  \"guid\": \"b53a16c8-9ce7-4289-8b27-375e8810d360\",\n  \"date\": \"2024-05-08T14:29:08.000+0000\",\n  \"author\": \"john@doe.com\",\n  \"comment\": \"Comment text\",\n  \"topic_guid\": \"18d0273d-e15c-4924-97b3-6f47b233eebe\",\n  \"modified_date\": \"2024-05-08T15:29:08.000+0000\",\n  \"modified_author\": \"john@doe.com\",\n  \"viewpoint_guid\": \"e765db1f-d705-4d6e-955c-28bf1a897818\",\n  \"authorization\": {\n    \"comment_actions\": [\n      {}\n    ]\n  }\n}"
        }
      ],
      "selectedLanguageId": "nZF8h3OZTtcUGrwVCfTFy"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}