---
title: List related topics
slug: topic-api/list-related-topics
docTags: 
createdAt: 2024-06-10T16:49:07.009Z
---

{
  "id": "4Lq3mkgwowfvXFd92BGMW",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/related_topics",
    "servers": [
      {
        "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/related_topics"
      }
    ],
    "name": "List related topics",
    "description": "List all related topics.",
    "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"
        }
      ],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "includeBimsyncProjectTopics",
          "type": "boolean",
          "description": "Include topics from other topic boards that belong to the same Catenda project"
        }
      ],
      "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": "array",
            "description": "List of related topics",
            "schema": [
              {
                "name": "related_topic_guid",
                "kind": "optional",
                "type": "string",
                "description": "Id of the related topic",
                "example": "5ae3214f-7333-4b3c-8b0a-1f8dca44616a"
              },
              {
                "name": "bimsync_issue_board_ref",
                "kind": "optional",
                "type": "string",
                "description": "Id of the topic board the related topic belongs",
                "example": "e18a2d10-1595-4e52-a941-22d43bf8d7ad"
              },
              {
                "name": "bimsync_issue_number",
                "kind": "optional",
                "type": "integer",
                "description": "Unique auto incremented number assigned when a new topic is created",
                "example": 24
              }
            ],
            "itemType": "object",
            "customType": "object[]",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "59bttgyMmx7siNGS7xLIo",
          "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}/related_topics \\\n     --header 'accept: application/json'"
        },
        {
          "id": "sjlv9H2RtrmfgfJzskdgo",
          "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}/related_topics\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "qo1xiy1-2OQuDzE0a9Dmv",
          "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}/related_topics\")\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": "5lIuJ-WpDfjAnvf7pFTlw",
          "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}/related_topics\"\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": "59bttgyMmx7siNGS7xLIo"
    },
    "results": {
      "languages": [
        {
          "id": "ly5zT2_M9Z6fYGCmztaTr",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"related_topic_guid\": \"5ae3214f-7333-4b3c-8b0a-1f8dca44616a\",\n    \"bimsync_issue_board_ref\": \"e18a2d10-1595-4e52-a941-22d43bf8d7ad\",\n    \"bimsync_issue_number\": 24\n  }\n]"
        }
      ],
      "selectedLanguageId": "ly5zT2_M9Z6fYGCmztaTr"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}