Get the knowledge source structure

`GET /knowledgeSourceStructure`

Returns the knowledge source structure tree. By default, website tree nodes whose source URL matches the parent connector's sourceConfig.excludePaths (fnmatch patterns) are omitted — this is the sidebar view. Pass withExcluded=true to include those nodes (each website node then carries excluded: true|false); used by the connector configuration view.

Query parameters

withExcludedbooleanquery

When true, include website tree nodes whose source matches the parent connector's excludePaths and tag each website node with excluded: true|false. When false (default) or omitted, those nodes are dropped from the response. Truthy values: true, 1, yes, on.

Responses

200 — Successful operation

Response Example

[
  {
    "id": 1,
    "name": "Fragen",
    "type": "faq",
    "description": "Allgemeine Fragen",
    "parent": 0,
    "articleId": 1,
    "source": "string",
    "excluded": true,
    "teams": [
      1,
      5
    ],
    "access": {
      "blocked": true,
      "blockedItems": [
        {
          "id": 42,
          "kind": "article"
        },
        {
          "id": 57,
          "kind": "folder"
        }
      ]
    },
    "children": [
      {
        "id": 2,
        "name": "Allgemeine Fragen",
        "parent": 1,
        "teams": [],
        "access": {
          "blocked": true,
          "blockedItems": [
            {
              "id": 42,
              "kind": "article"
            },
            {
              "id": 57,
              "kind": "folder"
            }
          ]
        },
        "children": [
          null
        ]
      }
    ]
  }
]

500 — Internal error