- KnowledgeBaseCategory
Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.
{ "entity_type": "Example String", "id": "Example String", "can_send_message": "Example String", "additional_info": [ "Example String" ] }
Available custom field definitions for inbox entities.
{ "customer": [ { "__typename": "Field" } ], "conversation": [ { "__typename": "Field" } ], "device": [ { "__typename": "Field" } ] }
A knowledge base article containing help content, documentation, or guides. Articles belong to categories within topics and support rich content, attachments, and reactions.
Unique code identifier for programmatic access.
The article title.
Brief summary or excerpt of the article content.
Full article content (HTML).
Publication status: 'draft', 'publish', or 'scheduled'.
Whether this article is only visible to team members.
Available emoji reaction types for this article.
Count of each reaction type received.
User ID of the article creator.
The resolved user who created this article.
When this article was created.
User ID of the last modifier.
When this article was last modified.
The topic this article belongs to.
The category this article belongs to.
Total number of times this article has been viewed.
File attachments included with this article.
Featured image for the article.
PDF attachment with extracted page images.
User ID of who published this article.
The resolved user who published this article.
Scheduled publication date (for status 'scheduled').
Forms embedded in this article.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "summary": "Example String", "content": "Example String", "status": "Example String", "isPrivate": true, "reactionChoices": [ "Example String" ], "reactionCounts": "Example Custom Scalar", "createdBy": "Example String", "createdUser": { "__typename": "User" }, "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "topicId": "Example String", "categoryId": "Example String", "viewCount": 40, "attachments": [ { "__typename": "Attachment" } ], "image": { "__typename": "Attachment" }, "pdfAttachment": { "__typename": "PdfAttachment" }, "publishedUserId": "Example String", "publishedUser": { "__typename": "User" }, "scheduledDate": "Example Custom Scalar", "forms": [ { "__typename": "FormCode" } ] }
Paginated list of knowledge base articles.
The list of articles for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseArticle" } ], "pagination": { "__typename": "PaginationInfo" } }
Paginated list of knowledge base categories.
The list of categories for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseCategory" } ], "pagination": { "__typename": "PaginationInfo" } }
A category that groups related knowledge base articles together. Categories can be nested under parent categories for hierarchical organization.
Unique code identifier for programmatic access.
The category title.
Description of what this category covers.
Articles in this category, optionally filtered by status.
Icon identifier for the category.
User ID of the category creator.
When this category was created.
User ID of the last modifier.
When this category was last modified.
Parent category ID for nested categorization.
The first topic this category belongs to.
Users who have authored articles in this category.
Count of articles in this category, optionally filtered by status.
Total article count in this category.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "description": "Example String", "articles": [ { "__typename": "KnowledgeBaseArticle" } ], "icon": "Example String", "createdBy": "Example String", "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "parentCategoryId": "Example String", "firstTopic": { "__typename": "KnowledgeBaseTopic" }, "authors": [ { "__typename": "User" } ], "numOfArticles": 40, "countArticles": 40 }
A category with its nested child categories included.
Unique code identifier.
The category title.
Description of what this category covers.
Articles directly in this parent category.
Icon identifier.
User ID of the creator.
When this category was created.
User ID of the last modifier.
When this category was last modified.
Parent category ID (for deeper nesting).
The first topic this category belongs to.
Users who have authored articles in this category.
Count of articles, optionally filtered by status.
Nested child categories.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "description": "Example String", "articles": [ { "__typename": "KnowledgeBaseArticle" } ], "icon": "Example String", "createdBy": "Example String", "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "parentCategoryId": "Example String", "firstTopic": { "__typename": "KnowledgeBaseTopic" }, "authors": [ { "__typename": "User" } ], "numOfArticles": 40, "childrens": [ { "__typename": "KnowledgeBaseCategory" } ] }
A single search result hit from the knowledge base vector search.
The article ID that matched.
Relevance score (higher is better).
Additional metadata about the match.
Highlighted text snippet showing the matching content.
{ "id": "Example String", "score": 40, "metadata": "Example Custom Scalar", "highlight": "Example String" }
Results from a knowledge base semantic search query.
The original search query.
Total number of matching results.
The search result hits, ordered by relevance.
Source citations for the results.
{ "query": "Example String", "totalResults": 40, "results": [ { "__typename": "KnowledgeBaseSearchHit" } ], "citations": [ "Example Custom Scalar" ] }
A knowledge base topic — the top-level organizational unit. Topics are associated with a brand and contain categories of articles. They can be styled with custom colors and background images.
Unique code identifier for programmatic access.
The topic title.
Description of the topic.
Categories within this topic.
URL of the background image for the topic page.
ISO language code for the topic content (e.g. 'en', 'ar').
User ID of the topic creator.
When this topic was created.
User ID of the last modifier.
When this topic was last modified.
Top-level parent categories within this topic.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "description": "Example String", "categories": [ { "__typename": "KnowledgeBaseCategory" } ], "workspace": { "__typename": "Workspace" }, "color": "Example String", "backgroundImage": "Example String", "languageCode": "Example String", "createdBy": "Example String", "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "parentCategories": [ { "__typename": "KnowledgeBaseParentCategory" } ] }
Paginated list of knowledge base topics.
The list of topics for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseTopic" } ], "pagination": { "__typename": "PaginationInfo" } }