Skip to content
Developers/
Other
/
/
knowledgeBaseCategoriesTo...

GraphQL Overview

Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.

Conversations & messaging

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview
Contacts & CRM

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview
Products & commerce

Queries

Overview

Mutations

Overview

Objects

Overview
Apps & credentials

Queries

Overview

Mutations

Overview

Objects

Overview
Organization

Queries

Overview

Objects

Overview

Enums

Overview
Other

Queries

Overview

knowledgeBaseTopics

(...args)
KnowledgeBaseTopicsPaginated

Arguments

page
Int
perPage
Int
workspaceId
String
codes
[String]

Return type

KnowledgeBaseTopicsPaginated
data
[KnowledgeBaseTopic]

The list of topics for the current page.

pagination
PaginationInfo

Pagination metadata.

Query sample
query knowledgeBaseTopics($page: Int, $perPage: Int, $workspaceId: String, $codes: [String]) {
  knowledgeBaseTopics(page: $page, perPage: $perPage, workspaceId: $workspaceId, codes: $codes) {
    data {
      _id 
      code 
      title 
      description 
      categories {
        __typename
        # ...KnowledgeBaseCategoryFragment
      }
      workspace {
        __typename
        # ...WorkspaceFragment
      }
      color 
      backgroundImage 
      languageCode 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategories {
        __typename
        # ...KnowledgeBaseParentCategoryFragment
      }
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
  }
}
Variables
{
  "page": 40,
  "perPage": 40,
  "workspaceId": "Example String",
  "codes": [
    "Example String"
  ]
}
Response sample
{
  "data": {
    "data": [
      {
        "_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"
          }
        ]
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

knowledgeBaseTopicDetail

(_id)
KnowledgeBaseTopic

Arguments

_id
String!,non-nullrequired

Return type

KnowledgeBaseTopic
_id
String!,non-null
code
String

Unique code identifier for programmatic access.

title
String

The topic title.

description
String

Description of the topic.

categories
[KnowledgeBaseCategory]

Categories within this topic.

workspace
Workspace
color
String
backgroundImage
String

URL of the background image for the topic page.

languageCode
String

ISO language code for the topic content (e.g. 'en', 'ar').

createdBy
String

User ID of the topic creator.

createdDate
Date

When this topic was created.

modifiedBy
String

User ID of the last modifier.

modifiedDate
Date

When this topic was last modified.

parentCategories
[KnowledgeBaseParentCategory]

Top-level parent categories within this topic.

Query sample
query knowledgeBaseTopicDetail($_id: String!) {
  knowledgeBaseTopicDetail(_id: $_id) {
    _id 
    code 
    title 
    description 
    categories {
      _id 
      code 
      title 
      description 
      articles(
        # Arguments Here
      ) {
        __typename
        # ...KnowledgeBaseArticleFragment
      }
      icon 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategoryId 
      firstTopic {
        __typename
        # ...KnowledgeBaseTopicFragment
      }
      authors {
        __typename
        # ...UserFragment
      }
      numOfArticles(
        # Arguments Here
      ) 
      countArticles 
    }
    workspace {
      _id 
      name 
      description 
      code 
      userId 
      createdAt 
      memberIds 
    }
    color 
    backgroundImage 
    languageCode 
    createdBy 
    createdDate 
    modifiedBy 
    modifiedDate 
    parentCategories {
      _id 
      code 
      title 
      description 
      articles {
        __typename
        # ...KnowledgeBaseArticleFragment
      }
      icon 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategoryId 
      firstTopic {
        __typename
        # ...KnowledgeBaseTopicFragment
      }
      authors {
        __typename
        # ...UserFragment
      }
      numOfArticles(
        # Arguments Here
      ) 
      childrens {
        __typename
        # ...KnowledgeBaseCategoryFragment
      }
    }
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_id": "Example String",
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "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,
        "countArticles": 40
      }
    ],
    "workspace": {
      "_id": "Example String",
      "name": "Example String",
      "description": "Example String",
      "code": "Example String",
      "userId": "Example String",
      "createdAt": "Example Custom Scalar",
      "memberIds": [
        "Example String"
      ]
    },
    "color": "Example String",
    "backgroundImage": "Example String",
    "languageCode": "Example String",
    "createdBy": "Example String",
    "createdDate": "Example Custom Scalar",
    "modifiedBy": "Example String",
    "modifiedDate": "Example Custom Scalar",
    "parentCategories": [
      {
        "_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"
          }
        ]
      }
    ]
  }
}

knowledgeBaseTopicsTotalCount

Int

Return the total number of knowledge base topics.

Return type

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Query sample
query knowledgeBaseTopicsTotalCount {
  knowledgeBaseTopicsTotalCount 
}
Response sample
{
  "data": 40
}

knowledgeBaseCategories

(...args)
KnowledgeBaseCategoriesPaginated

List knowledge base categories with pagination. Filter by topic, code, or icon.

Arguments

page
Int
perPage
Int
ids
[String]
topicIds
[String]
codes
[String]
icon
String

Return type

KnowledgeBaseCategoriesPaginated
data
[KnowledgeBaseCategory]

The list of categories for the current page.

pagination
PaginationInfo

Pagination metadata.

Query sample
query knowledgeBaseCategories(
  $page: Int
  $perPage: Int
  $ids: [String]
  $topicIds: [String]
  $codes: [String]
  $icon: String
) {
  knowledgeBaseCategories(
    page: $page
    perPage: $perPage
    ids: $ids
    topicIds: $topicIds
    codes: $codes
    icon: $icon
  ) {
    data {
      _id 
      code 
      title 
      description 
      articles(
        # Arguments Here
      ) {
        __typename
        # ...KnowledgeBaseArticleFragment
      }
      icon 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategoryId 
      firstTopic {
        __typename
        # ...KnowledgeBaseTopicFragment
      }
      authors {
        __typename
        # ...UserFragment
      }
      numOfArticles(
        # Arguments Here
      ) 
      countArticles 
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
  }
}
Variables
{
  "page": 40,
  "perPage": 40,
  "ids": [
    "Example String"
  ],
  "topicIds": [
    "Example String"
  ],
  "codes": [
    "Example String"
  ],
  "icon": "Example String"
}
Response sample
{
  "data": {
    "data": [
      {
        "_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
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

knowledgeBaseCategoryDetail

(_id)
KnowledgeBaseCategory

Retrieve a single knowledge base category by ID.

Arguments

_id
String!,non-nullrequired

Return type

KnowledgeBaseCategory
_id
String
code
String

Unique code identifier for programmatic access.

title
String

The category title.

description
String

Description of what this category covers.

articles
[KnowledgeBaseArticle]

Articles in this category, optionally filtered by status.

status
icon
String

Icon identifier for the category.

createdBy
String

User ID of the category creator.

createdDate
Date

When this category was created.

modifiedBy
String

User ID of the last modifier.

modifiedDate
Date

When this category was last modified.

parentCategoryId
String

Parent category ID for nested categorization.

firstTopic
KnowledgeBaseTopic

The first topic this category belongs to.

authors
[User]

Users who have authored articles in this category.

numOfArticles
Float

Count of articles in this category, optionally filtered by status.

status
countArticles
Int

Total article count in this category.

Query sample
query knowledgeBaseCategoryDetail($_id: String!) {
  knowledgeBaseCategoryDetail(_id: $_id) {
    _id 
    code 
    title 
    description 
    articles(
      # Arguments Here
    ) {
      _id 
      code 
      title 
      summary 
      content 
      status 
      isPrivate 
      reactionChoices 
      reactionCounts 
      createdBy 
      createdUser {
        __typename
        # ...UserFragment
      }
      createdDate 
      modifiedBy 
      modifiedDate 
      topicId 
      categoryId 
      viewCount 
      attachments {
        __typename
        # ...AttachmentFragment
      }
      image {
        __typename
        # ...AttachmentFragment
      }
      pdfAttachment {
        __typename
        # ...PdfAttachmentFragment
      }
      publishedUserId 
      publishedUser {
        __typename
        # ...UserFragment
      }
      scheduledDate 
      forms {
        __typename
        # ...FormCodeFragment
      }
    }
    icon 
    createdBy 
    createdDate 
    modifiedBy 
    modifiedDate 
    parentCategoryId 
    firstTopic {
      _id 
      code 
      title 
      description 
      categories {
        __typename
        # ...KnowledgeBaseCategoryFragment
      }
      workspace {
        __typename
        # ...WorkspaceFragment
      }
      color 
      backgroundImage 
      languageCode 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategories {
        __typename
        # ...KnowledgeBaseParentCategoryFragment
      }
    }
    authors {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    numOfArticles(
      # Arguments Here
    ) 
    countArticles 
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_id": "Example String",
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "articles": [
      {
        "_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"
          }
        ]
      }
    ],
    "icon": "Example String",
    "createdBy": "Example String",
    "createdDate": "Example Custom Scalar",
    "modifiedBy": "Example String",
    "modifiedDate": "Example Custom Scalar",
    "parentCategoryId": "Example String",
    "firstTopic": {
      "_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"
        }
      ]
    },
    "authors": [
      {
        "_id": "Example String",
        "createdAt": "Example Custom Scalar",
        "username": "Example String",
        "email": "Example String",
        "userPreferences": "Example Custom Scalar",
        "availability": "offline",
        "isActive": true,
        "details": {
          "__typename": "UserDetailsType"
        },
        "links": "Example Custom Scalar",
        "status": "Example String",
        "emailSignatures": "Example Custom Scalar",
        "groupIds": [
          "Example String"
        ],
        "workspaceIds": [
          "Example String"
        ],
        "isSubscribed": "Example String",
        "customFieldsData": "Example Custom Scalar",
        "workspaces": [
          {
            "__typename": "Workspace"
          }
        ],
        "isOwner": true,
        "permissionActions": "Example Custom Scalar",
        "configs": "Example Custom Scalar",
        "configsConstants": [
          "Example Custom Scalar"
        ],
        "onboardingHistory": {
          "__typename": "OnboardingHistory"
        },
        "departmentIds": [
          "Example String"
        ],
        "departments": [
          {
            "__typename": "Department"
          }
        ],
        "branchIds": [
          "Example String"
        ],
        "branches": [
          {
            "__typename": "Branch"
          }
        ],
        "positionIds": [
          "Example String"
        ],
        "positions": [
          {
            "__typename": "Position"
          }
        ],
        "score": 40,
        "scoreCategories": {
          "__typename": "ScoreCategories"
        },
        "leaderBoardPosition": 40,
        "employeeId": "Example String",
        "isOnline": true
      }
    ],
    "numOfArticles": 40,
    "countArticles": 40
  }
}

knowledgeBaseCategoriesTotalCount

(...args)
Int

Return the total number of categories matching the given filters.

Arguments

topicIds
[String]
codes
[String]

Return type

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Query sample
query knowledgeBaseCategoriesTotalCount($topicIds: [String], $codes: [String]) {
  knowledgeBaseCategoriesTotalCount(topicIds: $topicIds, codes: $codes) 
}
Variables
{
  "topicIds": [
    "Example String"
  ],
  "codes": [
    "Example String"
  ]
}
Response sample
{
  "data": 40
}

knowledgeBaseCategoriesGetLast

KnowledgeBaseCategory

Return the most recently created knowledge base category.

Return type

KnowledgeBaseCategory
_id
String
code
String

Unique code identifier for programmatic access.

title
String

The category title.

description
String

Description of what this category covers.

articles
[KnowledgeBaseArticle]

Articles in this category, optionally filtered by status.

status
icon
String

Icon identifier for the category.

createdBy
String

User ID of the category creator.

createdDate
Date

When this category was created.

modifiedBy
String

User ID of the last modifier.

modifiedDate
Date

When this category was last modified.

parentCategoryId
String

Parent category ID for nested categorization.

firstTopic
KnowledgeBaseTopic

The first topic this category belongs to.

authors
[User]

Users who have authored articles in this category.

numOfArticles
Float

Count of articles in this category, optionally filtered by status.

status
countArticles
Int

Total article count in this category.

Query sample
query knowledgeBaseCategoriesGetLast {
  knowledgeBaseCategoriesGetLast {
    _id 
    code 
    title 
    description 
    articles(
      # Arguments Here
    ) {
      _id 
      code 
      title 
      summary 
      content 
      status 
      isPrivate 
      reactionChoices 
      reactionCounts 
      createdBy 
      createdUser {
        __typename
        # ...UserFragment
      }
      createdDate 
      modifiedBy 
      modifiedDate 
      topicId 
      categoryId 
      viewCount 
      attachments {
        __typename
        # ...AttachmentFragment
      }
      image {
        __typename
        # ...AttachmentFragment
      }
      pdfAttachment {
        __typename
        # ...PdfAttachmentFragment
      }
      publishedUserId 
      publishedUser {
        __typename
        # ...UserFragment
      }
      scheduledDate 
      forms {
        __typename
        # ...FormCodeFragment
      }
    }
    icon 
    createdBy 
    createdDate 
    modifiedBy 
    modifiedDate 
    parentCategoryId 
    firstTopic {
      _id 
      code 
      title 
      description 
      categories {
        __typename
        # ...KnowledgeBaseCategoryFragment
      }
      workspace {
        __typename
        # ...WorkspaceFragment
      }
      color 
      backgroundImage 
      languageCode 
      createdBy 
      createdDate 
      modifiedBy 
      modifiedDate 
      parentCategories {
        __typename
        # ...KnowledgeBaseParentCategoryFragment
      }
    }
    authors {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    numOfArticles(
      # Arguments Here
    ) 
    countArticles 
  }
}
Response sample
{
  "data": {
    "_id": "Example String",
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "articles": [
      {
        "_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"
          }
        ]
      }
    ],
    "icon": "Example String",
    "createdBy": "Example String",
    "createdDate": "Example Custom Scalar",
    "modifiedBy": "Example String",
    "modifiedDate": "Example Custom Scalar",
    "parentCategoryId": "Example String",
    "firstTopic": {
      "_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"
        }
      ]
    },
    "authors": [
      {
        "_id": "Example String",
        "createdAt": "Example Custom Scalar",
        "username": "Example String",
        "email": "Example String",
        "userPreferences": "Example Custom Scalar",
        "availability": "offline",
        "isActive": true,
        "details": {
          "__typename": "UserDetailsType"
        },
        "links": "Example Custom Scalar",
        "status": "Example String",
        "emailSignatures": "Example Custom Scalar",
        "groupIds": [
          "Example String"
        ],
        "workspaceIds": [
          "Example String"
        ],
        "isSubscribed": "Example String",
        "customFieldsData": "Example Custom Scalar",
        "workspaces": [
          {
            "__typename": "Workspace"
          }
        ],
        "isOwner": true,
        "permissionActions": "Example Custom Scalar",
        "configs": "Example Custom Scalar",
        "configsConstants": [
          "Example Custom Scalar"
        ],
        "onboardingHistory": {
          "__typename": "OnboardingHistory"
        },
        "departmentIds": [
          "Example String"
        ],
        "departments": [
          {
            "__typename": "Department"
          }
        ],
        "branchIds": [
          "Example String"
        ],
        "branches": [
          {
            "__typename": "Branch"
          }
        ],
        "positionIds": [
          "Example String"
        ],
        "positions": [
          {
            "__typename": "Position"
          }
        ],
        "score": 40,
        "scoreCategories": {
          "__typename": "ScoreCategories"
        },
        "leaderBoardPosition": 40,
        "employeeId": "Example String",
        "isOnline": true
      }
    ],
    "numOfArticles": 40,
    "countArticles": 40
  }
}

knowledgeBaseArticles

(...args)
KnowledgeBaseArticlesPaginated

List knowledge base articles with pagination, search, sorting, and filtering.

Arguments

searchValue
String
page
Int
perPage
Int
categoryIds
[String]
articleIds
[String]
codes
[String]
topicIds
[String]
sortField
String
sortDirection
SortDirection
status
String

Return type

KnowledgeBaseArticlesPaginated
data
[KnowledgeBaseArticle]

The list of articles for the current page.

pagination
PaginationInfo

Pagination metadata.

Query sample
query knowledgeBaseArticles(
  $searchValue: String
  $page: Int
  $perPage: Int
  $categoryIds: [String]
  $articleIds: [String]
  $codes: [String]
  $topicIds: [String]
  $sortField: String
  $sortDirection: SortDirection
  $status: String
) {
  knowledgeBaseArticles(
    searchValue: $searchValue
    page: $page
    perPage: $perPage
    categoryIds: $categoryIds
    articleIds: $articleIds
    codes: $codes
    topicIds: $topicIds
    sortField: $sortField
    sortDirection: $sortDirection
    status: $status
  ) {
    data {
      _id 
      code 
      title 
      summary 
      content 
      status 
      isPrivate 
      reactionChoices 
      reactionCounts 
      createdBy 
      createdUser {
        __typename
        # ...UserFragment
      }
      createdDate 
      modifiedBy 
      modifiedDate 
      topicId 
      categoryId 
      viewCount 
      attachments {
        __typename
        # ...AttachmentFragment
      }
      image {
        __typename
        # ...AttachmentFragment
      }
      pdfAttachment {
        __typename
        # ...PdfAttachmentFragment
      }
      publishedUserId 
      publishedUser {
        __typename
        # ...UserFragment
      }
      scheduledDate 
      forms {
        __typename
        # ...FormCodeFragment
      }
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
  }
}
Variables
{
  "searchValue": "Example String",
  "page": 40,
  "perPage": 40,
  "categoryIds": [
    "Example String"
  ],
  "articleIds": [
    "Example String"
  ],
  "codes": [
    "Example String"
  ],
  "topicIds": [
    "Example String"
  ],
  "sortField": "Example String",
  "sortDirection": "asc",
  "status": "Example String"
}
Response sample
{
  "data": {
    "data": [
      {
        "_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"
          }
        ]
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

knowledgeBaseArticleDetail

(_id)
KnowledgeBaseArticle

Retrieve a single knowledge base article by ID.

Arguments

_id
String!,non-nullrequired

Return type

KnowledgeBaseArticle
_id
String!,non-null
code
String

Unique code identifier for programmatic access.

title
String

The article title.

summary
String

Brief summary or excerpt of the article content.

content
String

Full article content (HTML).

status
String

Publication status: 'draft', 'publish', or 'scheduled'.

isPrivate
Boolean

Whether this article is only visible to team members.

reactionChoices
[String]

Available emoji reaction types for this article.

reactionCounts
JSON

Count of each reaction type received.

createdBy
String

User ID of the article creator.

createdUser
User

The resolved user who created this article.

createdDate
Date

When this article was created.

modifiedBy
String

User ID of the last modifier.

modifiedDate
Date

When this article was last modified.

topicId
String

The topic this article belongs to.

categoryId
String

The category this article belongs to.

viewCount
Int

Total number of times this article has been viewed.

attachments
[Attachment]

File attachments included with this article.

image
Attachment

Featured image for the article.

pdfAttachment
PdfAttachment

PDF attachment with extracted page images.

publishedUserId
String

User ID of who published this article.

publishedUser
User

The resolved user who published this article.

scheduledDate
Date

Scheduled publication date (for status 'scheduled').

forms
[FormCode]

Forms embedded in this article.

Query sample
query knowledgeBaseArticleDetail($_id: String!) {
  knowledgeBaseArticleDetail(_id: $_id) {
    _id 
    code 
    title 
    summary 
    content 
    status 
    isPrivate 
    reactionChoices 
    reactionCounts 
    createdBy 
    createdUser {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    createdDate 
    modifiedBy 
    modifiedDate 
    topicId 
    categoryId 
    viewCount 
    attachments {
      url 
      name 
      type 
      size 
      duration 
      locationData {
        __typename
        # ...LocationDataFragment
      }
    }
    image {
      url 
      name 
      type 
      size 
      duration 
      locationData {
        __typename
        # ...LocationDataFragment
      }
    }
    pdfAttachment {
      pdf {
        __typename
        # ...AttachmentFragment
      }
      pages {
        __typename
        # ...AttachmentFragment
      }
    }
    publishedUserId 
    publishedUser {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    scheduledDate 
    forms {
      workspaceId 
      formId 
    }
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_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": {
      "_id": "Example String",
      "createdAt": "Example Custom Scalar",
      "username": "Example String",
      "email": "Example String",
      "userPreferences": "Example Custom Scalar",
      "availability": "offline",
      "isActive": true,
      "details": {
        "__typename": "UserDetailsType"
      },
      "links": "Example Custom Scalar",
      "status": "Example String",
      "emailSignatures": "Example Custom Scalar",
      "groupIds": [
        "Example String"
      ],
      "workspaceIds": [
        "Example String"
      ],
      "isSubscribed": "Example String",
      "customFieldsData": "Example Custom Scalar",
      "workspaces": [
        {
          "__typename": "Workspace"
        }
      ],
      "isOwner": true,
      "permissionActions": "Example Custom Scalar",
      "configs": "Example Custom Scalar",
      "configsConstants": [
        "Example Custom Scalar"
      ],
      "onboardingHistory": {
        "__typename": "OnboardingHistory"
      },
      "departmentIds": [
        "Example String"
      ],
      "departments": [
        {
          "__typename": "Department"
        }
      ],
      "branchIds": [
        "Example String"
      ],
      "branches": [
        {
          "__typename": "Branch"
        }
      ],
      "positionIds": [
        "Example String"
      ],
      "positions": [
        {
          "__typename": "Position"
        }
      ],
      "score": 40,
      "scoreCategories": {
        "__typename": "ScoreCategories"
      },
      "leaderBoardPosition": 40,
      "employeeId": "Example String",
      "isOnline": true
    },
    "createdDate": "Example Custom Scalar",
    "modifiedBy": "Example String",
    "modifiedDate": "Example Custom Scalar",
    "topicId": "Example String",
    "categoryId": "Example String",
    "viewCount": 40,
    "attachments": [
      {
        "url": "Example String",
        "name": "Example String",
        "type": "Example String",
        "size": 40,
        "duration": 40,
        "locationData": {
          "__typename": "LocationData"
        }
      }
    ],
    "image": {
      "url": "Example String",
      "name": "Example String",
      "type": "Example String",
      "size": 40,
      "duration": 40,
      "locationData": {
        "__typename": "LocationData"
      }
    },
    "pdfAttachment": {
      "pdf": {
        "__typename": "Attachment"
      },
      "pages": [
        {
          "__typename": "Attachment"
        }
      ]
    },
    "publishedUserId": "Example String",
    "publishedUser": {
      "_id": "Example String",
      "createdAt": "Example Custom Scalar",
      "username": "Example String",
      "email": "Example String",
      "userPreferences": "Example Custom Scalar",
      "availability": "offline",
      "isActive": true,
      "details": {
        "__typename": "UserDetailsType"
      },
      "links": "Example Custom Scalar",
      "status": "Example String",
      "emailSignatures": "Example Custom Scalar",
      "groupIds": [
        "Example String"
      ],
      "workspaceIds": [
        "Example String"
      ],
      "isSubscribed": "Example String",
      "customFieldsData": "Example Custom Scalar",
      "workspaces": [
        {
          "__typename": "Workspace"
        }
      ],
      "isOwner": true,
      "permissionActions": "Example Custom Scalar",
      "configs": "Example Custom Scalar",
      "configsConstants": [
        "Example Custom Scalar"
      ],
      "onboardingHistory": {
        "__typename": "OnboardingHistory"
      },
      "departmentIds": [
        "Example String"
      ],
      "departments": [
        {
          "__typename": "Department"
        }
      ],
      "branchIds": [
        "Example String"
      ],
      "branches": [
        {
          "__typename": "Branch"
        }
      ],
      "positionIds": [
        "Example String"
      ],
      "positions": [
        {
          "__typename": "Position"
        }
      ],
      "score": 40,
      "scoreCategories": {
        "__typename": "ScoreCategories"
      },
      "leaderBoardPosition": 40,
      "employeeId": "Example String",
      "isOnline": true
    },
    "scheduledDate": "Example Custom Scalar",
    "forms": [
      {
        "workspaceId": "Example String",
        "formId": "Example String"
      }
    ]
  }
}

knowledgeBaseArticlesTotalCount

(...args)
Int

Return the total number of articles matching the given filters.

Arguments

categoryIds
[String]
codes
[String]
articleIds
[String]
topicIds
[String]
status
String

Return type

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Query sample
query knowledgeBaseArticlesTotalCount(
  $categoryIds: [String]
  $codes: [String]
  $articleIds: [String]
  $topicIds: [String]
  $status: String
) {
  knowledgeBaseArticlesTotalCount(
    categoryIds: $categoryIds
    codes: $codes
    articleIds: $articleIds
    topicIds: $topicIds
    status: $status
  ) 
}
Variables
{
  "categoryIds": [
    "Example String"
  ],
  "codes": [
    "Example String"
  ],
  "articleIds": [
    "Example String"
  ],
  "topicIds": [
    "Example String"
  ],
  "status": "Example String"
}
Response sample
{
  "data": 40
}

knowledgeBaseSearch

(...args)
KnowledgeBaseSearchResult!,non-null

Perform a semantic search across knowledge base articles using vector similarity.

Arguments

query
String!,non-nullrequired
kbTopicId
String!,non-nullrequired
topK
Int
filters
JSON
rerank
Boolean
rerankMethod
String
hybridAlpha
Float

Return type

KnowledgeBaseSearchResult!
query
String!,non-null

The original search query.

totalResults
Int!,non-null

Total number of matching results.

results
[KnowledgeBaseSearchHit!]!,non-null

The search result hits, ordered by relevance.

citations
[JSON!],non-null

Source citations for the results.

Query sample
query knowledgeBaseSearch(
  $query: String!
  $kbTopicId: String!
  $topK: Int
  $filters: JSON
  $rerank: Boolean
  $rerankMethod: String
  $hybridAlpha: Float
) {
  knowledgeBaseSearch(
    query: $query
    kbTopicId: $kbTopicId
    topK: $topK
    filters: $filters
    rerank: $rerank
    rerankMethod: $rerankMethod
    hybridAlpha: $hybridAlpha
  ) {
    query 
    totalResults 
    results {
      id 
      score 
      metadata 
      highlight 
    }
    citations 
  }
}
Variables
{
  "query": "Example String",
  "kbTopicId": "Example String",
  "topK": 40,
  "filters": "Example Custom Scalar",
  "rerank": true,
  "rerankMethod": "Example String",
  "hybridAlpha": 40
}
Response sample
{
  "data": {
    "query": "Example String",
    "totalResults": 40,
    "results": [
      {
        "id": "Example String",
        "score": 40,
        "metadata": "Example Custom Scalar",
        "highlight": "Example String"
      }
    ],
    "citations": [
      "Example Custom Scalar"
    ]
  }
}

Mutations

Overview

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview