Skip to content
Developers/
Other
/
/
currentUser

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

currentUser

User

Resolve the profile of the currently authenticated user.

Return type

User
_id
String!,non-null
createdAt
Date
username
String
email
String
userPreferences
JSON
availability
UserChatStatus
isActive
Boolean
details
UserDetailsType
links
JSON
status
String
emailSignatures
JSON
groupIds
[String]
workspaceIds
[String]
isSubscribed
String
customFieldsData
JSON
workspaces
[Workspace]
isOwner
Boolean
permissionActions
JSON
configs
JSON
configsConstants
[JSON]
onboardingHistory
OnboardingHistory
departmentIds
[String]
departments
[Department]
branchIds
[String]
branches
[Branch]
positionIds
[String]
positions
[Position]
score
Float
scoreCategories
ScoreCategories
leaderBoardPosition
Int
employeeId
String
isOnline
Boolean
Query sample
query currentUser {
  currentUser {
    _id 
    createdAt 
    username 
    email 
    userPreferences 
    availability 
    isActive 
    details {
      avatar 
      coverPhoto 
      fullName 
      shortName 
      birthDate 
      position 
      workStartedDate 
      location 
      description 
      operatorPhone 
      firstName 
      lastName 
      employeeId 
    }
    links 
    status 
    emailSignatures 
    groupIds 
    workspaceIds 
    isSubscribed 
    customFieldsData 
    workspaces {
      _id 
      name 
      description 
      code 
      userId 
      createdAt 
      memberIds 
    }
    isOwner 
    permissionActions 
    configs 
    configsConstants 
    onboardingHistory {
      _id 
      userId 
      isCompleted 
      completedSteps 
      sections {
        __typename
        # ...OnboardingSectionsFragment
      }
      dismissedAt 
      firstLoginAt 
      lastActivityAt 
    }
    departmentIds 
    departments {
      _id 
      title 
      description 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      parent {
        __typename
        # ...DepartmentFragment
      }
      children {
        __typename
        # ...DepartmentFragment
      }
      childCount 
      users {
        __typename
        # ...UserFragment
      }
      userCount 
      userIds 
    }
    branchIds 
    branches {
      _id 
      title 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
      parent {
        __typename
        # ...BranchFragment
      }
      children {
        __typename
        # ...BranchFragment
      }
      status 
      address 
      hasChildren 
    }
    positionIds 
    positions {
      _id 
      title 
      code 
      order 
      parentId 
      parent {
        __typename
        # ...PositionFragment
      }
      status 
      children {
        __typename
        # ...PositionFragment
      }
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
    }
    score 
    scoreCategories {
      speed {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      quality {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      productivity {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      training {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      engagement {
        __typename
        # ...ScoreCategoryEntryFragment
      }
    }
    leaderBoardPosition 
    employeeId 
    isOnline 
  }
}
Response sample
{
  "data": {
    "_id": "Example String",
    "createdAt": "Example Custom Scalar",
    "username": "Example String",
    "email": "Example String",
    "userPreferences": "Example Custom Scalar",
    "availability": "offline",
    "isActive": true,
    "details": {
      "avatar": "Example String",
      "coverPhoto": "Example String",
      "fullName": "Example String",
      "shortName": "Example String",
      "birthDate": "Example Custom Scalar",
      "position": "Example String",
      "workStartedDate": "Example Custom Scalar",
      "location": "Example String",
      "description": "Example String",
      "operatorPhone": "Example String",
      "firstName": "Example String",
      "lastName": "Example String",
      "employeeId": "Example String"
    },
    "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": [
      {
        "_id": "Example String",
        "name": "Example String",
        "description": "Example String",
        "code": "Example String",
        "userId": "Example String",
        "createdAt": "Example Custom Scalar",
        "memberIds": [
          "Example String"
        ]
      }
    ],
    "isOwner": true,
    "permissionActions": "Example Custom Scalar",
    "configs": "Example Custom Scalar",
    "configsConstants": [
      "Example Custom Scalar"
    ],
    "onboardingHistory": {
      "_id": "Example String",
      "userId": "Example String",
      "isCompleted": true,
      "completedSteps": [
        "Example String"
      ],
      "sections": {
        "__typename": "OnboardingSections"
      },
      "dismissedAt": "Example Custom Scalar",
      "firstLoginAt": "Example Custom Scalar",
      "lastActivityAt": "Example Custom Scalar"
    },
    "departmentIds": [
      "Example String"
    ],
    "departments": [
      {
        "_id": "Example String",
        "title": "Example String",
        "description": "Example String",
        "parentId": "Example String",
        "supervisorId": "Example String",
        "supervisor": {
          "__typename": "User"
        },
        "code": "Example String",
        "order": "Example String",
        "parent": {
          "__typename": "Department"
        },
        "children": [
          {
            "__typename": "Department"
          }
        ],
        "childCount": 40,
        "users": [
          {
            "__typename": "User"
          }
        ],
        "userCount": 40,
        "userIds": [
          "Example String"
        ]
      }
    ],
    "branchIds": [
      "Example String"
    ],
    "branches": [
      {
        "_id": "Example String",
        "title": "Example String",
        "parentId": "Example String",
        "supervisorId": "Example String",
        "supervisor": {
          "__typename": "User"
        },
        "code": "Example String",
        "order": "Example String",
        "users": [
          {
            "__typename": "User"
          }
        ],
        "userIds": [
          "Example String"
        ],
        "userCount": 40,
        "parent": {
          "__typename": "Branch"
        },
        "children": [
          {
            "__typename": "Branch"
          }
        ],
        "status": "Example String",
        "address": "Example String",
        "hasChildren": true
      }
    ],
    "positionIds": [
      "Example String"
    ],
    "positions": [
      {
        "_id": "Example String",
        "title": "Example String",
        "code": "Example String",
        "order": "Example String",
        "parentId": "Example String",
        "parent": {
          "__typename": "Position"
        },
        "status": "Example String",
        "children": [
          {
            "__typename": "Position"
          }
        ],
        "users": [
          {
            "__typename": "User"
          }
        ],
        "userIds": [
          "Example String"
        ],
        "userCount": 40
      }
    ],
    "score": 40,
    "scoreCategories": {
      "speed": {
        "__typename": "ScoreCategoryEntry"
      },
      "quality": {
        "__typename": "ScoreCategoryEntry"
      },
      "productivity": {
        "__typename": "ScoreCategoryEntry"
      },
      "training": {
        "__typename": "ScoreCategoryEntry"
      },
      "engagement": {
        "__typename": "ScoreCategoryEntry"
      }
    },
    "leaderBoardPosition": 40,
    "employeeId": "Example String",
    "isOnline": true
  }
}

inboxFields

InboxField

Retrieves available custom fields for inbox entities. Returns field definitions for customers, conversations, and devices.

Return type

InboxField
customer
[Field]

Custom fields available on customer records.

conversation
[Field]

Custom fields available on conversations.

device
[Field]

Custom fields available on device/browser data.

Query sample
query inboxFields {
  inboxFields {
    customer {
      _id 
      contentType 
      contentTypeId 
      name 
      isVisible 
      isVisibleInDetail 
      canHide 
      groupId 
      lastUpdatedUser {
        __typename
        # ...UserFragment
      }
      lastUpdatedUserId 
      associatedField {
        __typename
        # ...FieldFragment
      }
      locationOptions {
        __typename
        # ...LocationOptionFragment
      }
      objectListConfigs {
        __typename
        # ...ObjectListConfigFragment
      }
      optionsValues 
      subFieldIds 
      subFields {
        __typename
        # ...FieldFragment
      }
      products {
        __typename
        # ...ProductFragment
      }
      logics {
        __typename
        # ...LogicFragment
      }
      description 
      options 
      type 
      validation 
      regexValidation 
      text 
      content 
      isRequired 
      order 
      associatedFieldId 
      logicAction 
      column 
      pageNumber 
      code 
      searchable 
      showInCard 
      isVisibleToCreate 
      productCategoryId 
      field 
      isDefinedByKarzoun 
    }
    conversation {
      _id 
      contentType 
      contentTypeId 
      name 
      isVisible 
      isVisibleInDetail 
      canHide 
      groupId 
      lastUpdatedUser {
        __typename
        # ...UserFragment
      }
      lastUpdatedUserId 
      associatedField {
        __typename
        # ...FieldFragment
      }
      locationOptions {
        __typename
        # ...LocationOptionFragment
      }
      objectListConfigs {
        __typename
        # ...ObjectListConfigFragment
      }
      optionsValues 
      subFieldIds 
      subFields {
        __typename
        # ...FieldFragment
      }
      products {
        __typename
        # ...ProductFragment
      }
      logics {
        __typename
        # ...LogicFragment
      }
      description 
      options 
      type 
      validation 
      regexValidation 
      text 
      content 
      isRequired 
      order 
      associatedFieldId 
      logicAction 
      column 
      pageNumber 
      code 
      searchable 
      showInCard 
      isVisibleToCreate 
      productCategoryId 
      field 
      isDefinedByKarzoun 
    }
    device {
      _id 
      contentType 
      contentTypeId 
      name 
      isVisible 
      isVisibleInDetail 
      canHide 
      groupId 
      lastUpdatedUser {
        __typename
        # ...UserFragment
      }
      lastUpdatedUserId 
      associatedField {
        __typename
        # ...FieldFragment
      }
      locationOptions {
        __typename
        # ...LocationOptionFragment
      }
      objectListConfigs {
        __typename
        # ...ObjectListConfigFragment
      }
      optionsValues 
      subFieldIds 
      subFields {
        __typename
        # ...FieldFragment
      }
      products {
        __typename
        # ...ProductFragment
      }
      logics {
        __typename
        # ...LogicFragment
      }
      description 
      options 
      type 
      validation 
      regexValidation 
      text 
      content 
      isRequired 
      order 
      associatedFieldId 
      logicAction 
      column 
      pageNumber 
      code 
      searchable 
      showInCard 
      isVisibleToCreate 
      productCategoryId 
      field 
      isDefinedByKarzoun 
    }
  }
}
Response sample
{
  "data": {
    "customer": [
      {
        "_id": "Example String",
        "contentType": "Example String",
        "contentTypeId": "Example String",
        "name": "Example String",
        "isVisible": true,
        "isVisibleInDetail": true,
        "canHide": true,
        "groupId": "Example String",
        "lastUpdatedUser": {
          "__typename": "User"
        },
        "lastUpdatedUserId": "Example String",
        "associatedField": {
          "__typename": "Field"
        },
        "locationOptions": [
          {
            "__typename": "LocationOption"
          }
        ],
        "objectListConfigs": [
          {
            "__typename": "ObjectListConfig"
          }
        ],
        "optionsValues": "Example String",
        "subFieldIds": [
          "Example String"
        ],
        "subFields": [
          {
            "__typename": "Field"
          }
        ],
        "products": [
          {
            "__typename": "Product"
          }
        ],
        "logics": [
          {
            "__typename": "Logic"
          }
        ],
        "description": "Example String",
        "options": [
          "Example String"
        ],
        "type": "Example String",
        "validation": "Example String",
        "regexValidation": "Example String",
        "text": "Example String",
        "content": "Example String",
        "isRequired": true,
        "order": 40,
        "associatedFieldId": "Example String",
        "logicAction": "Example String",
        "column": 40,
        "pageNumber": 40,
        "code": "Example String",
        "searchable": true,
        "showInCard": true,
        "isVisibleToCreate": true,
        "productCategoryId": "Example String",
        "field": "Example String",
        "isDefinedByKarzoun": true
      }
    ],
    "conversation": [
      {
        "_id": "Example String",
        "contentType": "Example String",
        "contentTypeId": "Example String",
        "name": "Example String",
        "isVisible": true,
        "isVisibleInDetail": true,
        "canHide": true,
        "groupId": "Example String",
        "lastUpdatedUser": {
          "__typename": "User"
        },
        "lastUpdatedUserId": "Example String",
        "associatedField": {
          "__typename": "Field"
        },
        "locationOptions": [
          {
            "__typename": "LocationOption"
          }
        ],
        "objectListConfigs": [
          {
            "__typename": "ObjectListConfig"
          }
        ],
        "optionsValues": "Example String",
        "subFieldIds": [
          "Example String"
        ],
        "subFields": [
          {
            "__typename": "Field"
          }
        ],
        "products": [
          {
            "__typename": "Product"
          }
        ],
        "logics": [
          {
            "__typename": "Logic"
          }
        ],
        "description": "Example String",
        "options": [
          "Example String"
        ],
        "type": "Example String",
        "validation": "Example String",
        "regexValidation": "Example String",
        "text": "Example String",
        "content": "Example String",
        "isRequired": true,
        "order": 40,
        "associatedFieldId": "Example String",
        "logicAction": "Example String",
        "column": 40,
        "pageNumber": 40,
        "code": "Example String",
        "searchable": true,
        "showInCard": true,
        "isVisibleToCreate": true,
        "productCategoryId": "Example String",
        "field": "Example String",
        "isDefinedByKarzoun": true
      }
    ],
    "device": [
      {
        "_id": "Example String",
        "contentType": "Example String",
        "contentTypeId": "Example String",
        "name": "Example String",
        "isVisible": true,
        "isVisibleInDetail": true,
        "canHide": true,
        "groupId": "Example String",
        "lastUpdatedUser": {
          "__typename": "User"
        },
        "lastUpdatedUserId": "Example String",
        "associatedField": {
          "__typename": "Field"
        },
        "locationOptions": [
          {
            "__typename": "LocationOption"
          }
        ],
        "objectListConfigs": [
          {
            "__typename": "ObjectListConfig"
          }
        ],
        "optionsValues": "Example String",
        "subFieldIds": [
          "Example String"
        ],
        "subFields": [
          {
            "__typename": "Field"
          }
        ],
        "products": [
          {
            "__typename": "Product"
          }
        ],
        "logics": [
          {
            "__typename": "Logic"
          }
        ],
        "description": "Example String",
        "options": [
          "Example String"
        ],
        "type": "Example String",
        "validation": "Example String",
        "regexValidation": "Example String",
        "text": "Example String",
        "content": "Example String",
        "isRequired": true,
        "order": 40,
        "associatedFieldId": "Example String",
        "logicAction": "Example String",
        "column": 40,
        "pageNumber": 40,
        "code": "Example String",
        "searchable": true,
        "showInCard": true,
        "isVisibleToCreate": true,
        "productCategoryId": "Example String",
        "field": "Example String",
        "isDefinedByKarzoun": true
      }
    ]
  }
}

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
    }
  }
}

Mutations

Overview

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview