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

{
  "id": "FrxdRGixihWlMJTEBa58u",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints/{viewpoint-id}/visibility",
    "servers": [
      {
        "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints/{viewpoint-id}/visibility"
      }
    ],
    "name": "Get visibility",
    "description": "Get the visibility of a topic viewpoint.",
    "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": "viewpoint-id",
          "type": "string",
          "example": "52959166-dbd2-44eb-81bb-74f955f30e0f",
          "description": "Id of viewpoint"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "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": "viewpoint-visibility",
            "schema": [
              {
                "name": "visibility",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "default_visibility",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Visibility of exception components, default is false",
                    "example": true
                  },
                  {
                    "name": "exceptions",
                    "kind": "optional",
                    "type": "array",
                    "description": "Exception components",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "ifc_guid",
                        "kind": "optional",
                        "type": "string",
                        "description": "IFC guid of the component",
                        "example": "3BY5alwwL00QXHtY2qmHYZ"
                      },
                      {
                        "name": "originating_system",
                        "kind": "optional",
                        "type": "string",
                        "description": "Originating system of the component",
                        "example": ""
                      },
                      {
                        "name": "authoring_tool_id",
                        "kind": "optional",
                        "type": "string",
                        "description": "Id of the component in the authoring tool",
                        "example": ""
                      }
                    ]
                  },
                  {
                    "name": "view_setup_hints",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "example": "",
                    "schema": [
                      {
                        "name": "spaces_visible",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Visibility of spaces, default is false",
                        "example": true
                      },
                      {
                        "name": "space_boundaries_visible",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Visibility of space boundaries, default is false",
                        "example": true
                      },
                      {
                        "name": "openings_visible",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Visibility of openings, default is false",
                        "example": true
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/viewpoint-visibility",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "aZiyCR4Mv_LfiA-fKHzIY",
          "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}/viewpoints/{viewpoint-id}/visibility \\\n     --header 'accept: application/json'"
        },
        {
          "id": "OQaYq6-5VFlXWlb9cpbPs",
          "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}/viewpoints/{viewpoint-id}/visibility\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "mAvir1C5ODJSzbCSS_F6U",
          "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}/viewpoints/{viewpoint-id}/visibility\")\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": "Huc6nSTzF7Or4z-PGFU8M",
          "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}/viewpoints/{viewpoint-id}/visibility\"\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": "aZiyCR4Mv_LfiA-fKHzIY"
    },
    "results": {
      "languages": [
        {
          "id": "HUEwKCmBeOQEzlLk0XIJi",
          "language": "200",
          "code": "// OK\n{\n  \"visibility\": {\n    \"default_visibility\": true,\n    \"exceptions\": [\n      {\n        \"ifc_guid\": \"3BY5alwwL00QXHtY2qmHYZ\",\n        \"originating_system\": \"\",\n        \"authoring_tool_id\": \"\"\n      }\n    ],\n    \"view_setup_hints\": {\n      \"spaces_visible\": true,\n      \"space_boundaries_visible\": true,\n      \"openings_visible\": true\n    }\n  }\n}"
        }
      ],
      "selectedLanguageId": "HUEwKCmBeOQEzlLk0XIJi"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}