list_categories
Retrieve and filter categories within a knowledge base using IDs, active status, or custom queries for efficient organization and navigation.
Instructions
List categories in a knowledge base
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Filter by active status | |
| knowledge_base | No | Filter by knowledge base ID | |
| limit | No | Maximum number of categories to return | |
| offset | No | Offset for pagination | |
| parent_category | No | Filter by parent category ID | |
| query | No | Search query for categories |
Input Schema (JSON Schema)
{
"description": "Parameters for listing categories in a knowledge base.",
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by active status",
"title": "Active"
},
"knowledge_base": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by knowledge base ID",
"title": "Knowledge Base"
},
"limit": {
"default": 10,
"description": "Maximum number of categories to return",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Offset for pagination",
"title": "Offset",
"type": "integer"
},
"parent_category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by parent category ID",
"title": "Parent Category"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Search query for categories",
"title": "Query"
}
},
"title": "ListCategoriesParams",
"type": "object"
}