---
title: List topic boards
slug: topic-api/list-topic-boards
docTags: 
createdAt: 2024-06-10T16:49:07.008Z
---

{
  "id": "tuN4b5Ok8zAX0RZ349JJx",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/opencde/bcf/3.0/projects",
    "servers": [
      {
        "url": "https://api.catenda.com/opencde/bcf/3.0/projects"
      }
    ],
    "name": "List topic boards",
    "description": "List all the topic boards the current user has access to.\n\nMultiple topic boards may belong to a single Catenda project.\n",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "bimsync_project_id",
          "type": "string",
          "description": "Limit to topic boards that belong to the specified Catenda project id"
        },
        {
          "kind": "optional",
          "name": "bimsync_archived",
          "type": "string",
          "description": "<p>Limit to topic boards based on archived status, valid values are \"archived\", \"not-archived\" and \"all\".</p>"
        }
      ],
      "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": "",
            "customType": "bcf-topic-board[]",
            "schema": [
              {
                "name": "project_id",
                "kind": "optional",
                "type": "string",
                "description": "The topic board id",
                "example": "e18a2d10-1595-4e52-a941-22d43bf8d7ad"
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": "The topic board name",
                "example": "Issues"
              },
              {
                "name": "bimsync_project_id",
                "kind": "optional",
                "type": "string",
                "description": "Id of the Catenda project the topic board belongs to",
                "example": "2439e0a3-a21e-4135-8c09-9ae57ee12681"
              },
              {
                "name": "bimsync_issue_board_name",
                "kind": "optional",
                "type": "string",
                "description": "The topic board name on Catenda Hub",
                "example": "Issues"
              },
              {
                "name": "bimsync_project_name",
                "kind": "optional",
                "type": "string",
                "description": "Name of the Catenda project the topic board belongs to",
                "example": "Site A"
              },
              {
                "name": "bimsync_extension_acl",
                "kind": "optional",
                "type": "object",
                "description": "Map of access control features to access value for the current user",
                "example": "",
                "schema": [
                  {
                    "name": "canCloseIssues",
                    "kind": "optional",
                    "type": "string<all | own | none>",
                    "description": "Whether the current user can close topics, valid values are \"all\", \"own\" and \"none\".",
                    "example": "all"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/bcf-topic-board",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "kgAd9OBDxX4Q1ekatW912",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/opencde/bcf/3.0/projects \\\n     --header 'accept: application/json'"
        },
        {
          "id": "LbCZ4EfUisYp_e4cg6LO-",
          "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\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "6vtLVPoazCPypUzwhsq4y",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/opencde/bcf/3.0/projects\")\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": "8lYY7Ak2RkbolA82Br962",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/opencde/bcf/3.0/projects\"\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": "kgAd9OBDxX4Q1ekatW912"
    },
    "results": {
      "languages": [
        {
          "id": "dVg3d5Ueo7gnuBz3JOfyG",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"project_id\": \"e18a2d10-1595-4e52-a941-22d43bf8d7ad\",\n    \"name\": \"Issues\",\n    \"bimsync_project_id\": \"2439e0a3-a21e-4135-8c09-9ae57ee12681\",\n    \"bimsync_issue_board_name\": \"Issues\",\n    \"bimsync_project_name\": \"Site A\",\n    \"bimsync_extension_acl\": {\n      \"canCloseIssues\": \"all\"\n    }\n  }\n]"
        }
      ],
      "selectedLanguageId": "dVg3d5Ueo7gnuBz3JOfyG"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}