Skip to content
Developers/
/Mutations

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

Mutations

Overview

knowledgeBaseTopicsAdd

(doc)
KnowledgeBaseTopic

Create a new knowledge base topic.

Arguments

doc
KnowledgeBaseTopicDoc!,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.

Mutation sample
mutation knowledgeBaseTopicsAdd($doc: KnowledgeBaseTopicDoc!) {
  knowledgeBaseTopicsAdd(doc: $doc) {
    _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
{
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "categoryIds": [
      "Example String"
    ],
    "color": "Example String",
    "backgroundImage": "Example String",
    "languageCode": "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"
          }
        ]
      }
    ]
  }
}

knowledgeBaseTopicsEdit

(...args)
KnowledgeBaseTopic

Update an existing knowledge base topic.

Arguments

_id
String!,non-nullrequired
doc
KnowledgeBaseTopicDoc!,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.

Mutation sample
mutation knowledgeBaseTopicsEdit($_id: String!, $doc: KnowledgeBaseTopicDoc!) {
  knowledgeBaseTopicsEdit(_id: $_id, doc: $doc) {
    _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",
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "categoryIds": [
      "Example String"
    ],
    "color": "Example String",
    "backgroundImage": "Example String",
    "languageCode": "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"
          }
        ]
      }
    ]
  }
}

knowledgeBaseTopicsRemove

(_id)
JSON

Delete a knowledge base topic and disassociate its categories.

Arguments

_id
String!,non-nullrequired

Return type

JSON
Mutation sample
mutation knowledgeBaseTopicsRemove($_id: String!) {
  knowledgeBaseTopicsRemove(_id: $_id) 
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": "Example Custom Scalar"
}

knowledgeBaseCategoriesAdd

(doc)
KnowledgeBaseCategory

Create a new knowledge base category.

Arguments

doc
KnowledgeBaseCategoryDoc!,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.

Mutation sample
mutation knowledgeBaseCategoriesAdd($doc: KnowledgeBaseCategoryDoc!) {
  knowledgeBaseCategoriesAdd(doc: $doc) {
    _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
{
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "articleIds": [
      "Example String"
    ],
    "icon": "Example String",
    "topicIds": [
      "Example String"
    ],
    "topicId": "Example String",
    "parentCategoryId": "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
  }
}

knowledgeBaseCategoriesEdit

(...args)
KnowledgeBaseCategory

Update an existing knowledge base category.

Arguments

_id
String!,non-nullrequired
doc
KnowledgeBaseCategoryDoc!,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.

Mutation sample
mutation knowledgeBaseCategoriesEdit($_id: String!, $doc: KnowledgeBaseCategoryDoc!) {
  knowledgeBaseCategoriesEdit(_id: $_id, doc: $doc) {
    _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",
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "description": "Example String",
    "articleIds": [
      "Example String"
    ],
    "icon": "Example String",
    "topicIds": [
      "Example String"
    ],
    "topicId": "Example String",
    "parentCategoryId": "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
  }
}

knowledgeBaseCategoriesRemove

(_id)
JSON

Delete a knowledge base category and unlink its articles.

Arguments

_id
String!,non-nullrequired

Return type

JSON
Mutation sample
mutation knowledgeBaseCategoriesRemove($_id: String!) {
  knowledgeBaseCategoriesRemove(_id: $_id) 
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": "Example Custom Scalar"
}

knowledgeBaseArticlesAdd

(doc)
KnowledgeBaseArticle

Create a new knowledge base article.

Arguments

doc
KnowledgeBaseArticleDoc!,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.

Mutation sample
mutation knowledgeBaseArticlesAdd($doc: KnowledgeBaseArticleDoc!) {
  knowledgeBaseArticlesAdd(doc: $doc) {
    _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
{
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "summary": "Example String",
    "content": "Example String",
    "status": "Example String",
    "isPrivate": true,
    "reactionChoices": [
      "Example String"
    ],
    "categoryIds": [
      "Example String"
    ],
    "topicId": "Example String",
    "categoryId": "Example String",
    "image": {
      "url": "Example String",
      "name": "Example String",
      "type": "Example String",
      "size": 40,
      "duration": 40,
      "locationData": {
        "__typename": "LocationDataInput"
      }
    },
    "attachments": [
      {
        "url": "Example String",
        "name": "Example String",
        "type": "Example String",
        "size": 40,
        "duration": 40,
        "locationData": {
          "__typename": "LocationDataInput"
        }
      }
    ],
    "pdfAttachment": {
      "pdf": {
        "__typename": "AttachmentInput"
      },
      "pages": [
        {
          "__typename": "AttachmentInput"
        }
      ]
    },
    "scheduledDate": "Example Custom Scalar",
    "forms": [
      {
        "workspaceId": "Example String",
        "formId": "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"
      }
    ]
  }
}

knowledgeBaseArticlesEdit

(...args)
KnowledgeBaseArticle

Update an existing knowledge base article.

Arguments

_id
String!,non-nullrequired
doc
KnowledgeBaseArticleDoc!,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.

Mutation sample
mutation knowledgeBaseArticlesEdit($_id: String!, $doc: KnowledgeBaseArticleDoc!) {
  knowledgeBaseArticlesEdit(_id: $_id, doc: $doc) {
    _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",
  "doc": {
    "code": "Example String",
    "title": "Example String",
    "summary": "Example String",
    "content": "Example String",
    "status": "Example String",
    "isPrivate": true,
    "reactionChoices": [
      "Example String"
    ],
    "categoryIds": [
      "Example String"
    ],
    "topicId": "Example String",
    "categoryId": "Example String",
    "image": {
      "url": "Example String",
      "name": "Example String",
      "type": "Example String",
      "size": 40,
      "duration": 40,
      "locationData": {
        "__typename": "LocationDataInput"
      }
    },
    "attachments": [
      {
        "url": "Example String",
        "name": "Example String",
        "type": "Example String",
        "size": 40,
        "duration": 40,
        "locationData": {
          "__typename": "LocationDataInput"
        }
      }
    ],
    "pdfAttachment": {
      "pdf": {
        "__typename": "AttachmentInput"
      },
      "pages": [
        {
          "__typename": "AttachmentInput"
        }
      ]
    },
    "scheduledDate": "Example Custom Scalar",
    "forms": [
      {
        "workspaceId": "Example String",
        "formId": "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"
      }
    ]
  }
}

knowledgeBaseArticlesRemove

(_id)
JSON

Delete a knowledge base article.

Arguments

_id
String!,non-nullrequired

Return type

JSON
Mutation sample
mutation knowledgeBaseArticlesRemove($_id: String!) {
  knowledgeBaseArticlesRemove(_id: $_id) 
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": "Example Custom Scalar"
}

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview