GraphQL API Reference

How to get erxes-app-token

License

Free and open fair-code licensed under GNU General Public License v3.0 with Commons Clause.

https://www.gnu.org/licenses/gpl-3.0.html

Terms of Service

https://erxes.io/terms

API Endpoints
# Endpoint:
https://example.com/gateway/graphql
Headers
# Create app on erxes
erxes-app-token: <YOUR_TOKEN_HERE>

Contact us

If you need any further information join our server on discord
Join our server on discord

Queries

activityLogs

Response

Returns [ActivityLog]

Arguments
Name Description
activityType - String
contentId - String
contentType - String!
limit - Int

Example

Query
query ActivityLogs(
  $activityType: String,
  $contentId: String,
  $contentType: String!,
  $limit: Int
) {
  activityLogs(
    activityType: $activityType,
    contentId: $contentId,
    contentType: $contentType,
    limit: $limit
  ) {
    _id
    action
    content
    contentDetail
    contentId
    contentType
    contentTypeDetail
    createdAt
    createdBy
    createdByDetail
  }
}
Variables
{
  "activityType": "xyz789",
  "contentId": "abc123",
  "contentType": "abc123",
  "limit": 987
}
Response
{
  "data": {
    "activityLogs": [
      {
        "_id": "abc123",
        "action": "abc123",
        "content": {},
        "contentDetail": {},
        "contentId": "abc123",
        "contentType": "abc123",
        "contentTypeDetail": {},
        "createdAt": "2007-12-03",
        "createdBy": "abc123",
        "createdByDetail": {}
      }
    ]
  }
}

activityLogsByAction

Response

Returns an ActivityLogByActionResponse

Arguments
Name Description
action - String
contentType - String
page - Int
perPage - Int
pipelineId - String

Example

Query
query ActivityLogsByAction(
  $action: String,
  $contentType: String,
  $page: Int,
  $perPage: Int,
  $pipelineId: String
) {
  activityLogsByAction(
    action: $action,
    contentType: $contentType,
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId
  ) {
    activityLogs {
      _id
      action
      content
      contentId
      contentType
      contentTypeDetail
      createdAt
      createdBy
      createdUser {
        ...UserFragment
      }
    }
    totalCount
  }
}
Variables
{
  "action": "abc123",
  "contentType": "xyz789",
  "page": 123,
  "perPage": 123,
  "pipelineId": "abc123"
}
Response
{
  "data": {
    "activityLogsByAction": {
      "activityLogs": [ActivityLogByAction],
      "totalCount": 123
    }
  }
}

allBrands

Response

Returns [Brand]

Example

Query
query AllBrands {
  allBrands {
    _id
    code
    createdAt
    description
    emailConfig
    name
    userId
  }
}
Response
{
  "data": {
    "allBrands": [
      {
        "_id": "abc123",
        "code": "abc123",
        "createdAt": "2007-12-03",
        "description": "abc123",
        "emailConfig": {},
        "name": "xyz789",
        "userId": "xyz789"
      }
    ]
  }
}

allLeadIntegrations

Response

Returns [Integration]

Example

Query
query AllLeadIntegrations {
  allLeadIntegrations {
    _id
    bookingData {
      bookingFormText
      categoryTree
      description
      displayBlock
      image {
        ...AttachmentFragment
      }
      mainProductCategory {
        ...ProductCategoryFragment
      }
      name
      navigationText
      productCategoryId
      productFieldIds
      style
      userFilters
      viewCount
    }
    brand {
      _id
      code
      createdAt
      description
      emailConfig
      name
      userId
    }
    brandId
    channels {
      _id
      conversationCount
      createdAt
      description
      integrationIds
      integrations {
        ...IntegrationFragment
      }
      memberIds
      members {
        ...UserFragment
      }
      name
      openConversationCount
      userId
    }
    code
    departmentIds
    form {
      _id
      buttonText
      code
      createdDate
      createdUser {
        ...UserFragment
      }
      createdUserId
      description
      fields {
        ...FieldFragment
      }
      googleMapApiKey
      numberOfPages
      title
      type
    }
    formId
    healthStatus
    isActive
    kind
    knowledgeBaseMessengerApps {
      _id
      accountId
      credentials
      kind
      name
      showInInbox
    }
    languageCode
    leadData
    leadMessengerApps {
      _id
      accountId
      credentials
      kind
      name
      showInInbox
    }
    messengerData
    name
    tagIds
    tags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    uiOptions
    visibility
    webhookData
    websiteMessengerApps {
      _id
      accountId
      credentials
      kind
      name
      showInInbox
    }
  }
}
Response
{
  "data": {
    "allLeadIntegrations": [
      {
        "_id": "abc123",
        "bookingData": BookingData,
        "brand": Brand,
        "brandId": "abc123",
        "channels": [Channel],
        "code": "xyz789",
        "departmentIds": ["xyz789"],
        "form": Form,
        "formId": "abc123",
        "healthStatus": {},
        "isActive": false,
        "kind": "abc123",
        "knowledgeBaseMessengerApps": [MessengerApp],
        "languageCode": "abc123",
        "leadData": {},
        "leadMessengerApps": [MessengerApp],
        "messengerData": {},
        "name": "xyz789",
        "tagIds": ["abc123"],
        "tags": [Tag],
        "uiOptions": {},
        "visibility": "xyz789",
        "webhookData": {},
        "websiteMessengerApps": [MessengerApp]
      }
    ]
  }
}

allUsers

Response

Returns [User]

Arguments
Name Description
isActive - Boolean

Example

Query
query AllUsers($isActive: Boolean) {
  allUsers(isActive: $isActive) {
    _id
    brandIds
    brands {
      _id
      code
      createdAt
      description
      emailConfig
      name
      userId
    }
    configs
    configsConstants
    createdAt
    customFieldsData
    department {
      _id
      childCount
      children {
        ...DepartmentFragment
      }
      code
      description
      parent {
        ...DepartmentFragment
      }
      parentId
      supervisor {
        ...UserFragment
      }
      supervisorId
      title
      userCount
      userIds
      users {
        ...UserFragment
      }
    }
    details {
      avatar
      birthDate
      description
      fullName
      location
      operatorPhone
      position
      shortName
      workStartedDate
    }
    email
    emailSignatures
    getNotificationByEmail
    groupIds
    isActive
    isOwner
    isShowNotification
    isSubscribed
    leaderBoardPosition
    links
    onboardingHistory {
      _id
      completedSteps
      isCompleted
      userId
    }
    permissionActions
    score
    status
    username
  }
}
Variables
{"isActive": false}
Response
{
  "data": {
    "allUsers": [
      {
        "_id": "xyz789",
        "brandIds": ["xyz789"],
        "brands": [Brand],
        "configs": {},
        "configsConstants": [{}],
        "createdAt": "2007-12-03",
        "customFieldsData": {},
        "department": Department,
        "details": UserDetailsType,
        "email": "abc123",
        "emailSignatures": {},
        "getNotificationByEmail": true,
        "groupIds": ["abc123"],
        "isActive": false,
        "isOwner": false,
        "isShowNotification": true,
        "isSubscribed": "abc123",
        "leaderBoardPosition": 123,
        "links": {},
        "onboardingHistory": OnboardingHistory,
        "permissionActions": {},
        "score": 987.65,
        "status": "abc123",
        "username": "xyz789"
      }
    ]
  }
}

appDetail

Response

Returns an App

Arguments
Name Description
_id - String

Example

Query
query AppDetail($_id: String) {
  appDetail(_id: $_id) {
    _id
    accessToken
    createdAt
    expireDate
    isEnabled
    name
    refreshToken
    userGroupId
    userGroupName
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "appDetail": {
      "_id": "abc123",
      "accessToken": "abc123",
      "createdAt": "2007-12-03",
      "expireDate": "2007-12-03",
      "isEnabled": true,
      "name": "abc123",
      "refreshToken": "abc123",
      "userGroupId": "xyz789",
      "userGroupName": "xyz789"
    }
  }
}

apps

Response

Returns [App]

Example

Query
query Apps {
  apps {
    _id
    accessToken
    createdAt
    expireDate
    isEnabled
    name
    refreshToken
    userGroupId
    userGroupName
  }
}
Response
{
  "data": {
    "apps": [
      {
        "_id": "abc123",
        "accessToken": "xyz789",
        "createdAt": "2007-12-03",
        "expireDate": "2007-12-03",
        "isEnabled": false,
        "name": "xyz789",
        "refreshToken": "xyz789",
        "userGroupId": "abc123",
        "userGroupName": "abc123"
      }
    ]
  }
}

appsTotalCount

Response

Returns an Int

Example

Query
query AppsTotalCount {
  appsTotalCount
}
Response
{"data": {"appsTotalCount": 987}}

archivedDeals

Response

Returns [Deal]

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
page - Int
perPage - Int
pipelineId - String!
priorities - [String]
productIds - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedDeals(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $page: Int,
  $perPage: Int,
  $pipelineId: String!,
  $priorities: [String],
  $productIds: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedDeals(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId,
    priorities: $priorities,
    productIds: $productIds,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  ) {
    _id
    amount
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    paymentsData
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    products
    productsData
    reminderMinute
    score
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["xyz789"],
  "customerIds": ["abc123"],
  "endDate": "xyz789",
  "labelIds": ["abc123"],
  "page": 987,
  "perPage": 123,
  "pipelineId": "xyz789",
  "priorities": ["abc123"],
  "productIds": ["xyz789"],
  "search": "abc123",
  "startDate": "abc123",
  "userIds": ["abc123"]
}
Response
{
  "data": {
    "archivedDeals": [
      {
        "_id": "abc123",
        "amount": {},
        "assignedUserIds": ["xyz789"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "xyz789",
        "closeDate": "2007-12-03",
        "companies": [Company],
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "customers": [Customer],
        "description": "xyz789",
        "hasNotified": false,
        "isComplete": true,
        "isWatched": false,
        "labelIds": ["xyz789"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "abc123",
        "name": "xyz789",
        "number": "xyz789",
        "order": 123.45,
        "paymentsData": {},
        "pipeline": Pipeline,
        "priority": "abc123",
        "products": {},
        "productsData": {},
        "reminderMinute": 123,
        "score": 987.65,
        "stage": Stage,
        "stageId": "abc123",
        "startDate": "2007-12-03",
        "status": "xyz789",
        "timeTrack": TimeTrack,
        "userId": "abc123"
      }
    ]
  }
}

archivedDealsCount

Response

Returns an Int

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
pipelineId - String!
priorities - [String]
productIds - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedDealsCount(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $pipelineId: String!,
  $priorities: [String],
  $productIds: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedDealsCount(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    pipelineId: $pipelineId,
    priorities: $priorities,
    productIds: $productIds,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  )
}
Variables
{
  "assignedUserIds": ["abc123"],
  "companyIds": ["xyz789"],
  "customerIds": ["xyz789"],
  "endDate": "xyz789",
  "labelIds": ["xyz789"],
  "pipelineId": "xyz789",
  "priorities": ["abc123"],
  "productIds": ["abc123"],
  "search": "abc123",
  "startDate": "abc123",
  "userIds": ["xyz789"]
}
Response
{"data": {"archivedDealsCount": 987}}

archivedGrowthHacks

Response

Returns [GrowthHack]

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
hackStages - [String]
labelIds - [String]
page - Int
perPage - Int
pipelineId - String!
priorities - [String]
productIds - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedGrowthHacks(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $hackStages: [String],
  $labelIds: [String],
  $page: Int,
  $perPage: Int,
  $pipelineId: String!,
  $priorities: [String],
  $productIds: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedGrowthHacks(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    hackStages: $hackStages,
    labelIds: $labelIds,
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId,
    priorities: $priorities,
    productIds: $productIds,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  ) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    confidence
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    description
    ease
    formFields {
      _id
      associatedField {
        ...FieldFragment
      }
      associatedFieldId
      canHide
      code
      column
      content
      contentType
      contentTypeId
      description
      groupId
      groupName
      isDefinedByErxes
      isRequired
      isVisible
      isVisibleInDetail
      lastUpdatedUser {
        ...UserFragment
      }
      lastUpdatedUserId
      locationOptions {
        ...LocationOptionFragment
      }
      logicAction
      logics {
        ...LogicFragment
      }
      name
      objectListConfigs {
        ...ObjectListConfigFragment
      }
      options
      order
      pageNumber
      productCategoryId
      products {
        ...ProductFragment
      }
      searchable
      showInCard
      text
      type
      validation
    }
    formId
    formSubmissions
    hackStages
    hasNotified
    impact
    isComplete
    isVoted
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reach
    reminderMinute
    score
    scoringType
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
    voteCount
    votedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
  }
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["abc123"],
  "customerIds": ["abc123"],
  "endDate": "abc123",
  "hackStages": ["abc123"],
  "labelIds": ["xyz789"],
  "page": 123,
  "perPage": 987,
  "pipelineId": "xyz789",
  "priorities": ["abc123"],
  "productIds": ["abc123"],
  "search": "abc123",
  "startDate": "xyz789",
  "userIds": ["xyz789"]
}
Response
{
  "data": {
    "archivedGrowthHacks": [
      {
        "_id": "abc123",
        "assignedUserIds": ["xyz789"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "abc123",
        "closeDate": "2007-12-03",
        "confidence": 987,
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "description": "xyz789",
        "ease": 123,
        "formFields": [Field],
        "formId": "xyz789",
        "formSubmissions": {},
        "hackStages": ["abc123"],
        "hasNotified": true,
        "impact": 123,
        "isComplete": false,
        "isVoted": false,
        "isWatched": false,
        "labelIds": ["abc123"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "abc123",
        "name": "xyz789",
        "number": "xyz789",
        "order": 987.65,
        "pipeline": Pipeline,
        "priority": "xyz789",
        "reach": 987,
        "reminderMinute": 123,
        "score": 123.45,
        "scoringType": "xyz789",
        "stage": Stage,
        "stageId": "xyz789",
        "startDate": "2007-12-03",
        "status": "abc123",
        "timeTrack": TimeTrack,
        "userId": "xyz789",
        "voteCount": 123,
        "votedUsers": [User]
      }
    ]
  }
}

archivedGrowthHacksCount

Response

Returns an Int

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
hackStages - [String]
labelIds - [String]
pipelineId - String!
priorities - [String]
productIds - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedGrowthHacksCount(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $hackStages: [String],
  $labelIds: [String],
  $pipelineId: String!,
  $priorities: [String],
  $productIds: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedGrowthHacksCount(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    hackStages: $hackStages,
    labelIds: $labelIds,
    pipelineId: $pipelineId,
    priorities: $priorities,
    productIds: $productIds,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  )
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["abc123"],
  "customerIds": ["xyz789"],
  "endDate": "abc123",
  "hackStages": ["abc123"],
  "labelIds": ["abc123"],
  "pipelineId": "abc123",
  "priorities": ["xyz789"],
  "productIds": ["abc123"],
  "search": "abc123",
  "startDate": "abc123",
  "userIds": ["abc123"]
}
Response
{"data": {"archivedGrowthHacksCount": 123}}

archivedStages

Response

Returns [Stage]

Arguments
Name Description
page - Int
perPage - Int
pipelineId - String!
search - String

Example

Query
query ArchivedStages(
  $page: Int,
  $perPage: Int,
  $pipelineId: String!,
  $search: String
) {
  archivedStages(
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId,
    search: $search
  ) {
    _id
    age
    amount
    code
    compareNextStage
    createdAt
    departmentIds
    formId
    inProcessDealsTotalCount
    initialDealsTotalCount
    itemsTotalCount
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    order
    pipelineId
    probability
    status
    stayedDealsTotalCount
    type
    visibility
  }
}
Variables
{
  "page": 987,
  "perPage": 987,
  "pipelineId": "abc123",
  "search": "abc123"
}
Response
{
  "data": {
    "archivedStages": [
      {
        "_id": "abc123",
        "age": 123,
        "amount": {},
        "code": "xyz789",
        "compareNextStage": {},
        "createdAt": "2007-12-03",
        "departmentIds": ["abc123"],
        "formId": "xyz789",
        "inProcessDealsTotalCount": 123,
        "initialDealsTotalCount": 123,
        "itemsTotalCount": 123,
        "memberIds": ["abc123"],
        "members": [User],
        "name": "xyz789",
        "order": 123,
        "pipelineId": "abc123",
        "probability": "xyz789",
        "status": "abc123",
        "stayedDealsTotalCount": 987,
        "type": "abc123",
        "visibility": "abc123"
      }
    ]
  }
}

archivedStagesCount

Response

Returns an Int

Arguments
Name Description
pipelineId - String!
search - String

Example

Query
query ArchivedStagesCount(
  $pipelineId: String!,
  $search: String
) {
  archivedStagesCount(
    pipelineId: $pipelineId,
    search: $search
  )
}
Variables
{
  "pipelineId": "abc123",
  "search": "abc123"
}
Response
{"data": {"archivedStagesCount": 987}}

archivedTasks

Response

Returns [Task]

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
page - Int
perPage - Int
pipelineId - String!
priorities - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedTasks(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $page: Int,
  $perPage: Int,
  $pipelineId: String!,
  $priorities: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedTasks(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId,
    priorities: $priorities,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  ) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reminderMinute
    score
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["abc123"],
  "customerIds": ["xyz789"],
  "endDate": "xyz789",
  "labelIds": ["xyz789"],
  "page": 123,
  "perPage": 123,
  "pipelineId": "abc123",
  "priorities": ["xyz789"],
  "search": "xyz789",
  "startDate": "xyz789",
  "userIds": ["xyz789"]
}
Response
{
  "data": {
    "archivedTasks": [
      {
        "_id": "abc123",
        "assignedUserIds": ["xyz789"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "abc123",
        "closeDate": "2007-12-03",
        "companies": [Company],
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "customers": [Customer],
        "description": "abc123",
        "hasNotified": true,
        "isComplete": true,
        "isWatched": true,
        "labelIds": ["abc123"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "abc123",
        "name": "abc123",
        "number": "abc123",
        "order": 123.45,
        "pipeline": Pipeline,
        "priority": "abc123",
        "reminderMinute": 123,
        "score": 123.45,
        "stage": Stage,
        "stageId": "xyz789",
        "startDate": "2007-12-03",
        "status": "xyz789",
        "timeTrack": TimeTrack,
        "userId": "abc123"
      }
    ]
  }
}

archivedTasksCount

Response

Returns an Int

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
pipelineId - String!
priorities - [String]
search - String
startDate - String
userIds - [String]

Example

Query
query ArchivedTasksCount(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $pipelineId: String!,
  $priorities: [String],
  $search: String,
  $startDate: String,
  $userIds: [String]
) {
  archivedTasksCount(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    pipelineId: $pipelineId,
    priorities: $priorities,
    search: $search,
    startDate: $startDate,
    userIds: $userIds
  )
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["xyz789"],
  "customerIds": ["abc123"],
  "endDate": "abc123",
  "labelIds": ["xyz789"],
  "pipelineId": "xyz789",
  "priorities": ["xyz789"],
  "search": "xyz789",
  "startDate": "abc123",
  "userIds": ["abc123"]
}
Response
{"data": {"archivedTasksCount": 123}}

archivedTickets

Response

Returns [Ticket]

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
page - Int
perPage - Int
pipelineId - String!
priorities - [String]
search - String
sources - [String]
startDate - String
userIds - [String]

Example

Query
query ArchivedTickets(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $page: Int,
  $perPage: Int,
  $pipelineId: String!,
  $priorities: [String],
  $search: String,
  $sources: [String],
  $startDate: String,
  $userIds: [String]
) {
  archivedTickets(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    page: $page,
    perPage: $perPage,
    pipelineId: $pipelineId,
    priorities: $priorities,
    search: $search,
    sources: $sources,
    startDate: $startDate,
    userIds: $userIds
  ) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reminderMinute
    score
    source
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["abc123"],
  "customerIds": ["xyz789"],
  "endDate": "abc123",
  "labelIds": ["abc123"],
  "page": 987,
  "perPage": 987,
  "pipelineId": "abc123",
  "priorities": ["abc123"],
  "search": "xyz789",
  "sources": ["abc123"],
  "startDate": "xyz789",
  "userIds": ["xyz789"]
}
Response
{
  "data": {
    "archivedTickets": [
      {
        "_id": "abc123",
        "assignedUserIds": ["xyz789"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "abc123",
        "closeDate": "2007-12-03",
        "companies": [Company],
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "customers": [Customer],
        "description": "xyz789",
        "hasNotified": true,
        "isComplete": true,
        "isWatched": false,
        "labelIds": ["xyz789"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "xyz789",
        "name": "xyz789",
        "number": "xyz789",
        "order": 987.65,
        "pipeline": Pipeline,
        "priority": "abc123",
        "reminderMinute": 987,
        "score": 987.65,
        "source": "abc123",
        "stage": Stage,
        "stageId": "xyz789",
        "startDate": "2007-12-03",
        "status": "xyz789",
        "timeTrack": TimeTrack,
        "userId": "abc123"
      }
    ]
  }
}

archivedTicketsCount

Response

Returns an Int

Arguments
Name Description
assignedUserIds - [String]
companyIds - [String]
customerIds - [String]
endDate - String
labelIds - [String]
pipelineId - String!
priorities - [String]
search - String
sources - [String]
startDate - String
userIds - [String]

Example

Query
query ArchivedTicketsCount(
  $assignedUserIds: [String],
  $companyIds: [String],
  $customerIds: [String],
  $endDate: String,
  $labelIds: [String],
  $pipelineId: String!,
  $priorities: [String],
  $search: String,
  $sources: [String],
  $startDate: String,
  $userIds: [String]
) {
  archivedTicketsCount(
    assignedUserIds: $assignedUserIds,
    companyIds: $companyIds,
    customerIds: $customerIds,
    endDate: $endDate,
    labelIds: $labelIds,
    pipelineId: $pipelineId,
    priorities: $priorities,
    search: $search,
    sources: $sources,
    startDate: $startDate,
    userIds: $userIds
  )
}
Variables
{
  "assignedUserIds": ["xyz789"],
  "companyIds": ["xyz789"],
  "customerIds": ["xyz789"],
  "endDate": "abc123",
  "labelIds": ["xyz789"],
  "pipelineId": "abc123",
  "priorities": ["abc123"],
  "search": "abc123",
  "sources": ["xyz789"],
  "startDate": "abc123",
  "userIds": ["xyz789"]
}
Response
{"data": {"archivedTicketsCount": 123}}

automationConfigPrievewCount

Response

Returns an Int

Arguments
Name Description
config - JSON

Example

Query
query AutomationConfigPrievewCount($config: JSON) {
  automationConfigPrievewCount(config: $config)
}
Variables
{"config": {}}
Response
{"data": {"automationConfigPrievewCount": 987}}

automationDetail

Response

Returns an Automation

Arguments
Name Description
_id - String!

Example

Query
query AutomationDetail($_id: String!) {
  automationDetail(_id: $_id) {
    _id
    actions {
      config
      description
      icon
      id
      label
      nextActionId
      style
      type
    }
    createdAt
    createdBy
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    status
    triggers {
      actionId
      config
      count
      description
      icon
      id
      label
      style
      type
    }
    updatedAt
    updatedBy
    updatedUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "automationDetail": {
      "_id": "xyz789",
      "actions": [Action],
      "createdAt": "2007-12-03",
      "createdBy": "abc123",
      "createdUser": User,
      "name": "abc123",
      "status": "abc123",
      "triggers": [Trigger],
      "updatedAt": "2007-12-03",
      "updatedBy": "xyz789",
      "updatedUser": User
    }
  }
}

automationHistories

Response

Returns [AutomationHistory]

Arguments
Name Description
automationId - String!
beginDate - Date
endDate - Date
page - Int
perPage - Int
status - String
triggerId - String
triggerType - String

Example

Query
query AutomationHistories(
  $automationId: String!,
  $beginDate: Date,
  $endDate: Date,
  $page: Int,
  $perPage: Int,
  $status: String,
  $triggerId: String,
  $triggerType: String
) {
  automationHistories(
    automationId: $automationId,
    beginDate: $beginDate,
    endDate: $endDate,
    page: $page,
    perPage: $perPage,
    status: $status,
    triggerId: $triggerId,
    triggerType: $triggerType
  ) {
    _id
    actions
    automationId
    createdAt
    description
    modifiedAt
    nextActionId
    startWaitingDate
    status
    target
    targetId
    triggerConfig
    triggerId
    triggerType
    waitingActionId
  }
}
Variables
{
  "automationId": "abc123",
  "beginDate": "2007-12-03",
  "endDate": "2007-12-03",
  "page": 123,
  "perPage": 123,
  "status": "abc123",
  "triggerId": "abc123",
  "triggerType": "abc123"
}
Response
{
  "data": {
    "automationHistories": [
      {
        "_id": "abc123",
        "actions": [{}],
        "automationId": "abc123",
        "createdAt": "2007-12-03",
        "description": "abc123",
        "modifiedAt": "2007-12-03",
        "nextActionId": "xyz789",
        "startWaitingDate": "2007-12-03",
        "status": "xyz789",
        "target": {},
        "targetId": "xyz789",
        "triggerConfig": {},
        "triggerId": "abc123",
        "triggerType": "xyz789",
        "waitingActionId": "abc123"
      }
    ]
  }
}

automationNotes

Response

Returns [AutomationNote]

Arguments
Name Description
actionId - String
automationId - String!
triggerId - String

Example

Query
query AutomationNotes(
  $actionId: String,
  $automationId: String!,
  $triggerId: String
) {
  automationNotes(
    actionId: $actionId,
    automationId: $automationId,
    triggerId: $triggerId
  ) {
    _id
    actionId
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    description
    triggerId
  }
}
Variables
{
  "actionId": "abc123",
  "automationId": "xyz789",
  "triggerId": "xyz789"
}
Response
{
  "data": {
    "automationNotes": [
      {
        "_id": "abc123",
        "actionId": "xyz789",
        "createdAt": "2007-12-03",
        "createdUser": User,
        "description": "abc123",
        "triggerId": "abc123"
      }
    ]
  }
}

automations

Response

Returns [Automation]

Arguments
Name Description
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
sortDirection - Int
sortField - String
status - String

Example

Query
query Automations(
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $sortDirection: Int,
  $sortField: String,
  $status: String
) {
  automations(
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    sortDirection: $sortDirection,
    sortField: $sortField,
    status: $status
  ) {
    _id
    actions {
      config
      description
      icon
      id
      label
      nextActionId
      style
      type
    }
    createdAt
    createdBy
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    status
    triggers {
      actionId
      config
      count
      description
      icon
      id
      label
      style
      type
    }
    updatedAt
    updatedBy
    updatedUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
  }
}
Variables
{
  "excludeIds": false,
  "ids": ["abc123"],
  "page": 123,
  "perPage": 987,
  "searchValue": "xyz789",
  "sortDirection": 123,
  "sortField": "xyz789",
  "status": "xyz789"
}
Response
{
  "data": {
    "automations": [
      {
        "_id": "abc123",
        "actions": [Action],
        "createdAt": "2007-12-03",
        "createdBy": "abc123",
        "createdUser": User,
        "name": "xyz789",
        "status": "abc123",
        "triggers": [Trigger],
        "updatedAt": "2007-12-03",
        "updatedBy": "xyz789",
        "updatedUser": User
      }
    ]
  }
}

automationsMain

Response

Returns an AutomationsListResponse

Arguments
Name Description
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
sortDirection - Int
sortField - String
status - String

Example

Query
query AutomationsMain(
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $sortDirection: Int,
  $sortField: String,
  $status: String
) {
  automationsMain(
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    sortDirection: $sortDirection,
    sortField: $sortField,
    status: $status
  ) {
    list {
      _id
      actions {
        ...ActionFragment
      }
      createdAt
      createdBy
      createdUser {
        ...UserFragment
      }
      name
      status
      triggers {
        ...TriggerFragment
      }
      updatedAt
      updatedBy
      updatedUser {
        ...UserFragment
      }
    }
    totalCount
  }
}
Variables
{
  "excludeIds": false,
  "ids": ["xyz789"],
  "page": 123,
  "perPage": 123,
  "searchValue": "abc123",
  "sortDirection": 987,
  "sortField": "abc123",
  "status": "abc123"
}
Response
{
  "data": {
    "automationsMain": {
      "list": [Automation],
      "totalCount": 123.45
    }
  }
}

automationsTotalCount

Response

Returns an automationsTotalCountResponse

Arguments
Name Description
status - String

Example

Query
query AutomationsTotalCount($status: String) {
  automationsTotalCount(status: $status) {
    byStatus
    total
  }
}
Variables
{"status": "abc123"}
Response
{"data": {"automationsTotalCount": {"byStatus": 123, "total": 987}}}

boardContentTypeDetail

Response

Returns a JSON

Arguments
Name Description
contentId - String
contentType - String

Example

Query
query BoardContentTypeDetail(
  $contentId: String,
  $contentType: String
) {
  boardContentTypeDetail(
    contentId: $contentId,
    contentType: $contentType
  )
}
Variables
{
  "contentId": "xyz789",
  "contentType": "xyz789"
}
Response
{"data": {"boardContentTypeDetail": {}}}

boardCounts

Response

Returns [BoardCount]

Arguments
Name Description
type - String!

Example

Query
query BoardCounts($type: String!) {
  boardCounts(type: $type) {
    _id
    count
    name
  }
}
Variables
{"type": "abc123"}
Response
{
  "data": {
    "boardCounts": [
      {
        "_id": "xyz789",
        "count": 123,
        "name": "abc123"
      }
    ]
  }
}

boardDetail

Response

Returns a Board

Arguments
Name Description
_id - String!

Example

Query
query BoardDetail($_id: String!) {
  boardDetail(_id: $_id) {
    _id
    createdAt
    name
    order
    pipelines {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    type
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "boardDetail": {
      "_id": "xyz789",
      "createdAt": "2007-12-03",
      "name": "abc123",
      "order": 987,
      "pipelines": [Pipeline],
      "type": "abc123"
    }
  }
}

boardGetLast

Response

Returns a Board

Arguments
Name Description
type - String!

Example

Query
query BoardGetLast($type: String!) {
  boardGetLast(type: $type) {
    _id
    createdAt
    name
    order
    pipelines {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    type
  }
}
Variables
{"type": "abc123"}
Response
{
  "data": {
    "boardGetLast": {
      "_id": "xyz789",
      "createdAt": "2007-12-03",
      "name": "abc123",
      "order": 123,
      "pipelines": [Pipeline],
      "type": "abc123"
    }
  }
}

boardLogs

Response

Returns a JSON

Arguments
Name Description
action - String
content - JSON
contentId - String
contentType - String

Example

Query
query BoardLogs(
  $action: String,
  $content: JSON,
  $contentId: String,
  $contentType: String
) {
  boardLogs(
    action: $action,
    content: $content,
    contentId: $contentId,
    contentType: $contentType
  )
}
Variables
{
  "action": "xyz789",
  "content": {},
  "contentId": "abc123",
  "contentType": "xyz789"
}
Response
{"data": {"boardLogs": {}}}

boards

Response

Returns [Board]

Arguments
Name Description
type - String!

Example

Query
query Boards($type: String!) {
  boards(type: $type) {
    _id
    createdAt
    name
    order
    pipelines {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    type
  }
}
Variables
{"type": "abc123"}
Response
{
  "data": {
    "boards": [
      {
        "_id": "xyz789",
        "createdAt": "2007-12-03",
        "name": "xyz789",
        "order": 987,
        "pipelines": [Pipeline],
        "type": "abc123"
      }
    ]
  }
}

branchDetail

Response

Returns a Branch

Arguments
Name Description
_id - String!

Example

Query
query BranchDetail($_id: String!) {
  branchDetail(_id: $_id) {
    _id
    address
    children {
      _id
      address
      children {
        ...BranchFragment
      }
      code
      coordinate {
        ...CoordinateFragment
      }
      email
      image {
        ...AttachmentFragment
      }
      links
      parent {
        ...BranchFragment
      }
      parentId
      phoneNumber
      supervisor {
        ...UserFragment
      }
      supervisorId
      title
      userIds
      users {
        ...UserFragment
      }
    }
    code
    coordinate {
      latitude
      longitude
    }
    email
    image {
      duration
      name
      size
      type
      url
    }
    links
    parent {
      _id
      address
      children {
        ...BranchFragment
      }
      code
      coordinate {
        ...CoordinateFragment
      }
      email
      image {
        ...AttachmentFragment
      }
      links
      parent {
        ...BranchFragment
      }
      parentId
      phoneNumber
      supervisor {
        ...UserFragment
      }
      supervisorId
      title
      userIds
      users {
        ...UserFragment
      }
    }
    parentId
    phoneNumber
    supervisor {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    supervisorId
    title
    userIds
    users {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
  }
}
Variables
{"_id": "abc123"}
Response
{
  "data": {
    "branchDetail": {
      "_id": "abc123",
      "address": "abc123",
      "children": [Branch],
      "code": "xyz789",
      "coordinate": Coordinate,
      "email": "xyz789",
      "image": Attachment,
      "links": {},
      "parent": Branch,
      "parentId": "xyz789",
      "phoneNumber": "xyz789",
      "supervisor": User,
      "supervisorId": "abc123",
      "title": "abc123",
      "userIds": ["abc123"],
      "users": [User]
    }
  }
}

branches

Response

Returns [Branch]

Arguments
Name Description
searchValue - String

Example

Query
query Branches($searchValue: String) {
  branches(searchValue: $searchValue) {
    _id
    address
    children {
      _id
      address
      children {
        ...BranchFragment
      }
      code
      coordinate {
        ...CoordinateFragment
      }
      email
      image {
        ...AttachmentFragment
      }
      links
      parent {
        ...BranchFragment
      }
      parentId
      phoneNumber
      supervisor {
        ...UserFragment
      }
      supervisorId
      title
      userIds
      users {
        ...UserFragment
      }
    }
    code
    coordinate {
      latitude
      longitude
    }
    email
    image {
      duration
      name
      size
      type
      url
    }
    links
    parent {
      _id
      address
      children {
        ...BranchFragment
      }
      code
      coordinate {
        ...CoordinateFragment
      }
      email
      image {
        ...AttachmentFragment
      }
      links
      parent {
        ...BranchFragment
      }
      parentId
      phoneNumber
      supervisor {
        ...UserFragment
      }
      supervisorId
      title
      userIds
      users {
        ...UserFragment
      }
    }
    parentId
    phoneNumber
    supervisor {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    supervisorId
    title
    userIds
    users {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
  }
}
Variables
{"searchValue": "xyz789"}
Response
{
  "data": {
    "branches": [
      {
        "_id": "abc123",
        "address": "abc123",
        "children": [Branch],
        "code": "xyz789",
        "coordinate": Coordinate,
        "email": "xyz789",
        "image": Attachment,
        "links": {},
        "parent": Branch,
        "parentId": "xyz789",
        "phoneNumber": "abc123",
        "supervisor": User,
        "supervisorId": "xyz789",
        "title": "xyz789",
        "userIds": ["xyz789"],
        "users": [User]
      }
    ]
  }
}

brandDetail

Response

Returns a Brand

Arguments
Name Description
_id - String!

Example

Query
query BrandDetail($_id: String!) {
  brandDetail(_id: $_id) {
    _id
    code
    createdAt
    description
    emailConfig
    name
    userId
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "brandDetail": {
      "_id": "abc123",
      "code": "xyz789",
      "createdAt": "2007-12-03",
      "description": "abc123",
      "emailConfig": {},
      "name": "xyz789",
      "userId": "xyz789"
    }
  }
}

brands

Response

Returns [Brand]

Arguments
Name Description
page - Int
perPage - Int
searchValue - String

Example

Query
query Brands(
  $page: Int,
  $perPage: Int,
  $searchValue: String
) {
  brands(
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue
  ) {
    _id
    code
    createdAt
    description
    emailConfig
    name
    userId
  }
}
Variables
{
  "page": 123,
  "perPage": 123,
  "searchValue": "xyz789"
}
Response
{
  "data": {
    "brands": [
      {
        "_id": "xyz789",
        "code": "xyz789",
        "createdAt": "2007-12-03",
        "description": "xyz789",
        "emailConfig": {},
        "name": "xyz789",
        "userId": "abc123"
      }
    ]
  }
}

brandsGetLast

Response

Returns a Brand

Example

Query
query BrandsGetLast {
  brandsGetLast {
    _id
    code
    createdAt
    description
    emailConfig
    name
    userId
  }
}
Response
{
  "data": {
    "brandsGetLast": {
      "_id": "abc123",
      "code": "xyz789",
      "createdAt": "2007-12-03",
      "description": "abc123",
      "emailConfig": {},
      "name": "abc123",
      "userId": "abc123"
    }
  }
}

brandsTotalCount

Response

Returns an Int

Example

Query
query BrandsTotalCount {
  brandsTotalCount
}
Response
{"data": {"brandsTotalCount": 123}}

cardsFields

Response

Returns a JSON

Example

Query
query CardsFields {
  cardsFields
}
Response
{"data": {"cardsFields": {}}}

channelDetail

Response

Returns a Channel

Arguments
Name Description
_id - String!

Example

Query
query ChannelDetail($_id: String!) {
  channelDetail(_id: $_id) {
    _id
    conversationCount
    createdAt
    description
    integrationIds
    integrations {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    openConversationCount
    userId
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "channelDetail": {
      "_id": "xyz789",
      "conversationCount": 987,
      "createdAt": "2007-12-03",
      "description": "abc123",
      "integrationIds": ["abc123"],
      "integrations": [Integration],
      "memberIds": ["abc123"],
      "members": [User],
      "name": "xyz789",
      "openConversationCount": 987,
      "userId": "xyz789"
    }
  }
}

channels

Response

Returns [Channel]

Arguments
Name Description
memberIds - [String]
page - Int
perPage - Int

Example

Query
query Channels(
  $memberIds: [String],
  $page: Int,
  $perPage: Int
) {
  channels(
    memberIds: $memberIds,
    page: $page,
    perPage: $perPage
  ) {
    _id
    conversationCount
    createdAt
    description
    integrationIds
    integrations {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    openConversationCount
    userId
  }
}
Variables
{
  "memberIds": ["abc123"],
  "page": 987,
  "perPage": 123
}
Response
{
  "data": {
    "channels": [
      {
        "_id": "abc123",
        "conversationCount": 987,
        "createdAt": "2007-12-03",
        "description": "xyz789",
        "integrationIds": ["abc123"],
        "integrations": [Integration],
        "memberIds": ["abc123"],
        "members": [User],
        "name": "xyz789",
        "openConversationCount": 987,
        "userId": "abc123"
      }
    ]
  }
}

channelsByMembers

Response

Returns [Channel]

Arguments
Name Description
memberIds - [String]

Example

Query
query ChannelsByMembers($memberIds: [String]) {
  channelsByMembers(memberIds: $memberIds) {
    _id
    conversationCount
    createdAt
    description
    integrationIds
    integrations {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    openConversationCount
    userId
  }
}
Variables
{"memberIds": ["abc123"]}
Response
{
  "data": {
    "channelsByMembers": [
      {
        "_id": "abc123",
        "conversationCount": 987,
        "createdAt": "2007-12-03",
        "description": "abc123",
        "integrationIds": ["xyz789"],
        "integrations": [Integration],
        "memberIds": ["xyz789"],
        "members": [User],
        "name": "xyz789",
        "openConversationCount": 987,
        "userId": "xyz789"
      }
    ]
  }
}

channelsGetLast

Response

Returns a Channel

Example

Query
query ChannelsGetLast {
  channelsGetLast {
    _id
    conversationCount
    createdAt
    description
    integrationIds
    integrations {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    openConversationCount
    userId
  }
}
Response
{
  "data": {
    "channelsGetLast": {
      "_id": "abc123",
      "conversationCount": 123,
      "createdAt": "2007-12-03",
      "description": "xyz789",
      "integrationIds": ["abc123"],
      "integrations": [Integration],
      "memberIds": ["abc123"],
      "members": [User],
      "name": "abc123",
      "openConversationCount": 123,
      "userId": "xyz789"
    }
  }
}

channelsTotalCount

Response

Returns an Int

Example

Query
query ChannelsTotalCount {
  channelsTotalCount
}
Response
{"data": {"channelsTotalCount": 987}}

chatDetail

Response

Returns a Chat

Arguments
Name Description
_id - String!

Example

Query
query ChatDetail($_id: String!) {
  chatDetail(_id: $_id) {
    _id
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    description
    isSeen
    lastMessage {
      _id
      attachments
      content
      createdAt
      createdUser {
        ...UserFragment
      }
      isPinned
      mentionedUserIds
      relatedMessage {
        ...ChatMessageFragment
      }
      seenList {
        ...SeenInfoFragment
      }
    }
    name
    participantUsers {
      _id
      details {
        ...ChatUserDetailsFragment
      }
      email
      isAdmin
      username
    }
    type
    visibility
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "chatDetail": {
      "_id": "abc123",
      "createdAt": "2007-12-03",
      "createdUser": User,
      "description": "abc123",
      "isSeen": false,
      "lastMessage": ChatMessage,
      "name": "abc123",
      "participantUsers": [ChatUser],
      "type": "xyz789",
      "visibility": "xyz789"
    }
  }
}

chatMessageDetail

Response

Returns a ChatMessage

Arguments
Name Description
_id - String

Example

Query
query ChatMessageDetail($_id: String) {
  chatMessageDetail(_id: $_id) {
    _id
    attachments
    content
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    isPinned
    mentionedUserIds
    relatedMessage {
      _id
      attachments
      content
      createdAt
      createdUser {
        ...UserFragment
      }
      isPinned
      mentionedUserIds
      relatedMessage {
        ...ChatMessageFragment
      }
      seenList {
        ...SeenInfoFragment
      }
    }
    seenList {
      lastSeenMessageId
      seenDate
      user {
        ...UserFragment
      }
    }
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "chatMessageDetail": {
      "_id": "xyz789",
      "attachments": {},
      "content": "xyz789",
      "createdAt": "2007-12-03",
      "createdUser": User,
      "isPinned": true,
      "mentionedUserIds": ["abc123"],
      "relatedMessage": ChatMessage,
      "seenList": [SeenInfo]
    }
  }
}

chatMessages

Response

Returns a ChatMessageResponse

Arguments
Name Description
chatId - String
isPinned - Boolean
limit - Int
skip - Int

Example

Query
query ChatMessages(
  $chatId: String,
  $isPinned: Boolean,
  $limit: Int,
  $skip: Int
) {
  chatMessages(
    chatId: $chatId,
    isPinned: $isPinned,
    limit: $limit,
    skip: $skip
  ) {
    list {
      _id
      attachments
      content
      createdAt
      createdUser {
        ...UserFragment
      }
      isPinned
      mentionedUserIds
      relatedMessage {
        ...ChatMessageFragment
      }
      seenList {
        ...SeenInfoFragment
      }
    }
    totalCount
  }
}
Variables
{
  "chatId": "xyz789",
  "isPinned": false,
  "limit": 987,
  "skip": 987
}
Response
{
  "data": {
    "chatMessages": {
      "list": [ChatMessage],
      "totalCount": 123
    }
  }
}

chats

Response

Returns a ChatResponse

Arguments
Name Description
limit - Int
skip - Int
type - ChatType

Example

Query
query Chats(
  $limit: Int,
  $skip: Int,
  $type: ChatType
) {
  chats(
    limit: $limit,
    skip: $skip,
    type: $type
  ) {
    list {
      _id
      createdAt
      createdUser {
        ...UserFragment
      }
      description
      isSeen
      lastMessage {
        ...ChatMessageFragment
      }
      name
      participantUsers {
        ...ChatUserFragment
      }
      type
      visibility
    }
    totalCount
  }
}
Variables
{"limit": 987, "skip": 987, "type": "direct"}
Response
{"data": {"chats": {"list": [Chat], "totalCount": 123}}}

checkLoyalties

Response

Returns a JSON

Arguments
Name Description
ownerId - String
ownerType - String
products - JSON

Example

Query
query CheckLoyalties(
  $ownerId: String,
  $ownerType: String,
  $products: JSON
) {
  checkLoyalties(
    ownerId: $ownerId,
    ownerType: $ownerType,
    products: $products
  )
}
Variables
{
  "ownerId": "abc123",
  "ownerType": "abc123",
  "products": {}
}
Response
{"data": {"checkLoyalties": {}}}

checklistDetail

Response

Returns a Checklist

Arguments
Name Description
_id - String!

Example

Query
query ChecklistDetail($_id: String!) {
  checklistDetail(_id: $_id) {
    _id
    contentType
    contentTypeId
    createdDate
    createdUserId
    items {
      _id
      checklistId
      content
      isChecked
      order
    }
    percent
    title
  }
}
Variables
{"_id": "abc123"}
Response
{
  "data": {
    "checklistDetail": {
      "_id": "abc123",
      "contentType": "abc123",
      "contentTypeId": "abc123",
      "createdDate": "2007-12-03",
      "createdUserId": "xyz789",
      "items": [ChecklistItem],
      "percent": 123.45,
      "title": "abc123"
    }
  }
}

checklists

Response

Returns [Checklist]

Arguments
Name Description
contentType - String
contentTypeId - String

Example

Query
query Checklists(
  $contentType: String,
  $contentTypeId: String
) {
  checklists(
    contentType: $contentType,
    contentTypeId: $contentTypeId
  ) {
    _id
    contentType
    contentTypeId
    createdDate
    createdUserId
    items {
      _id
      checklistId
      content
      isChecked
      order
    }
    percent
    title
  }
}
Variables
{
  "contentType": "abc123",
  "contentTypeId": "xyz789"
}
Response
{
  "data": {
    "checklists": [
      {
        "_id": "xyz789",
        "contentType": "xyz789",
        "contentTypeId": "xyz789",
        "createdDate": "2007-12-03",
        "createdUserId": "abc123",
        "items": [ChecklistItem],
        "percent": 987.65,
        "title": "xyz789"
      }
    ]
  }
}

clientPortalConfigsTotalCount

Response

Returns an Int

Example

Query
query ClientPortalConfigsTotalCount {
  clientPortalConfigsTotalCount
}
Response
{"data": {"clientPortalConfigsTotalCount": 987}}

clientPortalCurrentUser

Response

Returns a ClientPortalUser

Example

Query
query ClientPortalCurrentUser {
  clientPortalCurrentUser {
    _id
    clientPortalId
    code
    createdAt
    customFieldsData
    email
    erxesCustomerId
    firstName
    lastName
    links
    modifiedAt
    ownerId
    password
    phone
    type
    username
  }
}
Response
{
  "data": {
    "clientPortalCurrentUser": {
      "_id": "xyz789",
      "clientPortalId": "abc123",
      "code": "abc123",
      "createdAt": "2007-12-03",
      "customFieldsData": {},
      "email": "xyz789",
      "erxesCustomerId": "abc123",
      "firstName": "abc123",
      "lastName": "abc123",
      "links": {},
      "modifiedAt": "2007-12-03",
      "ownerId": "abc123",
      "password": "xyz789",
      "phone": "abc123",
      "type": "abc123",
      "username": "abc123"
    }
  }
}

clientPortalGetConfig

Response

Returns a ClientPortal

Arguments
Name Description
_id - String!

Example

Query
query ClientPortalGetConfig($_id: String!) {
  clientPortalGetConfig(_id: $_id) {
    _id
    description
    dnsStatus
    domain
    footerHtml
    googleCredentials
    headerHtml
    icon
    kbToggle
    knowledgeBaseLabel
    knowledgeBaseTopicId
    logo
    messengerBrandCode
    mobileResponsive
    name
    otpConfig {
      codeLength
      content
      emailTransporterType
      smsTransporterType
    }
    publicTaskToggle
    styles {
      activeTabColor
      backgroundColor
      baseColor
      baseFont
      bodyColor
      dividerColor
      footerColor
      headerColor
      headingColor
      headingFont
      helpColor
      linkColor
      linkHoverColor
      primaryBtnColor
      secondaryBtnColor
    }
    taskBoardId
    taskLabel
    taskPipelineId
    taskPublicBoardId
    taskPublicPipelineId
    taskStageId
    taskToggle
    ticketBoardId
    ticketLabel
    ticketPipelineId
    ticketStageId
    ticketToggle
    url
  }
}
Variables
{"_id": "abc123"}
Response
{
  "data": {
    "clientPortalGetConfig": {
      "_id": "xyz789",
      "description": "abc123",
      "dnsStatus": "xyz789",
      "domain": "abc123",
      "footerHtml": "abc123",
      "googleCredentials": {},
      "headerHtml": "abc123",
      "icon": "abc123",
      "kbToggle": true,
      "knowledgeBaseLabel": "xyz789",
      "knowledgeBaseTopicId": "abc123",
      "logo": "xyz789",
      "messengerBrandCode": "abc123",
      "mobileResponsive": false,
      "name": "abc123",
      "otpConfig": OTPConfig,
      "publicTaskToggle": true,
      "styles": Styles,
      "taskBoardId": "abc123",
      "taskLabel": "xyz789",
      "taskPipelineId": "abc123",
      "taskPublicBoardId": "xyz789",
      "taskPublicPipelineId": "abc123",
      "taskStageId": "abc123",
      "taskToggle": true,
      "ticketBoardId": "abc123",
      "ticketLabel": "xyz789",
      "ticketPipelineId": "abc123",
      "ticketStageId": "abc123",
      "ticketToggle": false,
      "url": "abc123"
    }
  }
}

clientPortalGetConfigByDomain

Response

Returns a ClientPortal

Example

Query
query ClientPortalGetConfigByDomain {
  clientPortalGetConfigByDomain {
    _id
    description
    dnsStatus
    domain
    footerHtml
    googleCredentials
    headerHtml
    icon
    kbToggle
    knowledgeBaseLabel
    knowledgeBaseTopicId
    logo
    messengerBrandCode
    mobileResponsive
    name
    otpConfig {
      codeLength
      content
      emailTransporterType
      smsTransporterType
    }
    publicTaskToggle
    styles {
      activeTabColor
      backgroundColor
      baseColor
      baseFont
      bodyColor
      dividerColor
      footerColor
      headerColor
      headingColor
      headingFont
      helpColor
      linkColor
      linkHoverColor
      primaryBtnColor
      secondaryBtnColor
    }
    taskBoardId
    taskLabel
    taskPipelineId
    taskPublicBoardId
    taskPublicPipelineId
    taskStageId
    taskToggle
    ticketBoardId
    ticketLabel
    ticketPipelineId
    ticketStageId
    ticketToggle
    url
  }
}
Response
{
  "data": {
    "clientPortalGetConfigByDomain": {
      "_id": "xyz789",
      "description": "xyz789",
      "dnsStatus": "xyz789",
      "domain": "abc123",
      "footerHtml": "abc123",
      "googleCredentials": {},
      "headerHtml": "abc123",
      "icon": "abc123",
      "kbToggle": false,
      "knowledgeBaseLabel": "abc123",
      "knowledgeBaseTopicId": "xyz789",
      "logo": "xyz789",
      "messengerBrandCode": "xyz789",
      "mobileResponsive": true,
      "name": "xyz789",
      "otpConfig": OTPConfig,
      "publicTaskToggle": false,
      "styles": Styles,
      "taskBoardId": "xyz789",
      "taskLabel": "abc123",
      "taskPipelineId": "abc123",
      "taskPublicBoardId": "xyz789",
      "taskPublicPipelineId": "xyz789",
      "taskStageId": "xyz789",
      "taskToggle": false,
      "ticketBoardId": "abc123",
      "ticketLabel": "abc123",
      "ticketPipelineId": "xyz789",
      "ticketStageId": "abc123",
      "ticketToggle": true,
      "url": "xyz789"
    }
  }
}

clientPortalGetConfigs

Response

Returns [ClientPortal]

Arguments
Name Description
page - Int
perPage - Int

Example

Query
query ClientPortalGetConfigs(
  $page: Int,
  $perPage: Int
) {
  clientPortalGetConfigs(
    page: $page,
    perPage: $perPage
  ) {
    _id
    description
    dnsStatus
    domain
    footerHtml
    googleCredentials
    headerHtml
    icon
    kbToggle
    knowledgeBaseLabel
    knowledgeBaseTopicId
    logo
    messengerBrandCode
    mobileResponsive
    name
    otpConfig {
      codeLength
      content
      emailTransporterType
      smsTransporterType
    }
    publicTaskToggle
    styles {
      activeTabColor
      backgroundColor
      baseColor
      baseFont
      bodyColor
      dividerColor
      footerColor
      headerColor
      headingColor
      headingFont
      helpColor
      linkColor
      linkHoverColor
      primaryBtnColor
      secondaryBtnColor
    }
    taskBoardId
    taskLabel
    taskPipelineId
    taskPublicBoardId
    taskPublicPipelineId
    taskStageId
    taskToggle
    ticketBoardId
    ticketLabel
    ticketPipelineId
    ticketStageId
    ticketToggle
    url
  }
}
Variables
{"page": 987, "perPage": 987}
Response
{
  "data": {
    "clientPortalGetConfigs": [
      {
        "_id": "abc123",
        "description": "abc123",
        "dnsStatus": "abc123",
        "domain": "abc123",
        "footerHtml": "xyz789",
        "googleCredentials": {},
        "headerHtml": "abc123",
        "icon": "abc123",
        "kbToggle": true,
        "knowledgeBaseLabel": "abc123",
        "knowledgeBaseTopicId": "xyz789",
        "logo": "abc123",
        "messengerBrandCode": "xyz789",
        "mobileResponsive": true,
        "name": "abc123",
        "otpConfig": OTPConfig,
        "publicTaskToggle": true,
        "styles": Styles,
        "taskBoardId": "xyz789",
        "taskLabel": "abc123",
        "taskPipelineId": "xyz789",
        "taskPublicBoardId": "xyz789",
        "taskPublicPipelineId": "xyz789",
        "taskStageId": "xyz789",
        "taskToggle": false,
        "ticketBoardId": "xyz789",
        "ticketLabel": "abc123",
        "ticketPipelineId": "abc123",
        "ticketStageId": "abc123",
        "ticketToggle": false,
        "url": "xyz789"
      }
    ]
  }
}

clientPortalGetLast

Response

Returns a ClientPortal

Example

Query
query ClientPortalGetLast {
  clientPortalGetLast {
    _id
    description
    dnsStatus
    domain
    footerHtml
    googleCredentials
    headerHtml
    icon
    kbToggle
    knowledgeBaseLabel
    knowledgeBaseTopicId
    logo
    messengerBrandCode
    mobileResponsive
    name
    otpConfig {
      codeLength
      content
      emailTransporterType
      smsTransporterType
    }
    publicTaskToggle
    styles {
      activeTabColor
      backgroundColor
      baseColor
      baseFont
      bodyColor
      dividerColor
      footerColor
      headerColor
      headingColor
      headingFont
      helpColor
      linkColor
      linkHoverColor
      primaryBtnColor
      secondaryBtnColor
    }
    taskBoardId
    taskLabel
    taskPipelineId
    taskPublicBoardId
    taskPublicPipelineId
    taskStageId
    taskToggle
    ticketBoardId
    ticketLabel
    ticketPipelineId
    ticketStageId
    ticketToggle
    url
  }
}
Response
{
  "data": {
    "clientPortalGetLast": {
      "_id": "abc123",
      "description": "abc123",
      "dnsStatus": "abc123",
      "domain": "xyz789",
      "footerHtml": "abc123",
      "googleCredentials": {},
      "headerHtml": "xyz789",
      "icon": "abc123",
      "kbToggle": false,
      "knowledgeBaseLabel": "abc123",
      "knowledgeBaseTopicId": "xyz789",
      "logo": "abc123",
      "messengerBrandCode": "xyz789",
      "mobileResponsive": false,
      "name": "xyz789",
      "otpConfig": OTPConfig,
      "publicTaskToggle": true,
      "styles": Styles,
      "taskBoardId": "xyz789",
      "taskLabel": "xyz789",
      "taskPipelineId": "xyz789",
      "taskPublicBoardId": "xyz789",
      "taskPublicPipelineId": "abc123",
      "taskStageId": "abc123",
      "taskToggle": false,
      "ticketBoardId": "abc123",
      "ticketLabel": "xyz789",
      "ticketPipelineId": "xyz789",
      "ticketStageId": "abc123",
      "ticketToggle": true,
      "url": "abc123"
    }
  }
}

clientPortalGetTaskStages

Response

Returns [Stage]

Example

Query
query ClientPortalGetTaskStages {
  clientPortalGetTaskStages {
    _id
    age
    amount
    code
    compareNextStage
    createdAt
    departmentIds
    formId
    inProcessDealsTotalCount
    initialDealsTotalCount
    itemsTotalCount
    memberIds
    members {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    name
    order
    pipelineId
    probability
    status
    stayedDealsTotalCount
    type
    visibility
  }
}
Response
{
  "data": {
    "clientPortalGetTaskStages": [
      {
        "_id": "abc123",
        "age": 987,
        "amount": {},
        "code": "abc123",
        "compareNextStage": {},
        "createdAt": "2007-12-03",
        "departmentIds": ["abc123"],
        "formId": "xyz789",
        "inProcessDealsTotalCount": 987,
        "initialDealsTotalCount": 123,
        "itemsTotalCount": 123,
        "memberIds": ["abc123"],
        "members": [User],
        "name": "abc123",
        "order": 987,
        "pipelineId": "abc123",
        "probability": "abc123",
        "status": "xyz789",
        "stayedDealsTotalCount": 123,
        "type": "abc123",
        "visibility": "xyz789"
      }
    ]
  }
}

clientPortalGetTasks

Response

Returns [Task]

Arguments
Name Description
stageId - String!

Example

Query
query ClientPortalGetTasks($stageId: String!) {
  clientPortalGetTasks(stageId: $stageId) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reminderMinute
    score
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{"stageId": "abc123"}
Response
{
  "data": {
    "clientPortalGetTasks": [
      {
        "_id": "abc123",
        "assignedUserIds": ["xyz789"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "xyz789",
        "closeDate": "2007-12-03",
        "companies": [Company],
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "customers": [Customer],
        "description": "xyz789",
        "hasNotified": true,
        "isComplete": true,
        "isWatched": true,
        "labelIds": ["abc123"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "abc123",
        "name": "xyz789",
        "number": "xyz789",
        "order": 987.65,
        "pipeline": Pipeline,
        "priority": "xyz789",
        "reminderMinute": 123,
        "score": 123.45,
        "stage": Stage,
        "stageId": "abc123",
        "startDate": "2007-12-03",
        "status": "xyz789",
        "timeTrack": TimeTrack,
        "userId": "xyz789"
      }
    ]
  }
}

clientPortalKnowledgeBaseArticles

Response

Returns [KnowledgeBaseArticle]

Arguments
Name Description
categoryIds - [String]
searchValue - String

Example

Query
query ClientPortalKnowledgeBaseArticles(
  $categoryIds: [String],
  $searchValue: String
) {
  clientPortalKnowledgeBaseArticles(
    categoryIds: $categoryIds,
    searchValue: $searchValue
  ) {
    _id
    attachments {
      duration
      name
      size
      type
      url
    }
    categoryId
    content
    createdBy
    createdDate
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    image {
      duration
      name
      size
      type
      url
    }
    modifiedBy
    modifiedDate
    reactionChoices
    reactionCounts
    status
    summary
    title
    topicId
    viewCount
  }
}
Variables
{
  "categoryIds": ["abc123"],
  "searchValue": "xyz789"
}
Response
{
  "data": {
    "clientPortalKnowledgeBaseArticles": [
      {
        "_id": "xyz789",
        "attachments": [Attachment],
        "categoryId": "abc123",
        "content": "abc123",
        "createdBy": "abc123",
        "createdDate": "2007-12-03",
        "createdUser": User,
        "image": Attachment,
        "modifiedBy": "xyz789",
        "modifiedDate": "2007-12-03",
        "reactionChoices": ["xyz789"],
        "reactionCounts": {},
        "status": "abc123",
        "summary": "xyz789",
        "title": "xyz789",
        "topicId": "xyz789",
        "viewCount": 123
      }
    ]
  }
}

clientPortalKnowledgeBaseTopicDetail

Response

Returns a KnowledgeBaseTopic

Arguments
Name Description
_id - String!

Example

Query
query ClientPortalKnowledgeBaseTopicDetail($_id: String!) {
  clientPortalKnowledgeBaseTopicDetail(_id: $_id) {
    _id
    backgroundImage
    brand {
      _id
      code
      createdAt
      description
      emailConfig
      name
      userId
    }
    categories {
      _id
      articles {
        ...KnowledgeBaseArticleFragment
      }
      authors {
        ...UserFragment
      }
      createdBy
      createdDate
      description
      firstTopic {
        ...KnowledgeBaseTopicFragment
      }
      icon
      modifiedBy
      modifiedDate
      numOfArticles
      parentCategoryId
      title
    }
    color
    createdBy
    createdDate
    description
    languageCode
    modifiedBy
    modifiedDate
    parentCategories {
      _id
      articles {
        ...KnowledgeBaseArticleFragment
      }
      authors {
        ...UserFragment
      }
      childrens {
        ...KnowledgeBaseCategoryFragment
      }
      createdBy
      createdDate
      description
      firstTopic {
        ...KnowledgeBaseTopicFragment
      }
      icon
      modifiedBy
      modifiedDate
      numOfArticles
      parentCategoryId
      title
    }
    title
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "clientPortalKnowledgeBaseTopicDetail": {
      "_id": "abc123",
      "backgroundImage": "abc123",
      "brand": Brand,
      "categories": [KnowledgeBaseCategory],
      "color": "abc123",
      "createdBy": "xyz789",
      "createdDate": "2007-12-03",
      "description": "xyz789",
      "languageCode": "xyz789",
      "modifiedBy": "xyz789",
      "modifiedDate": "2007-12-03",
      "parentCategories": [KnowledgeBaseParentCategory],
      "title": "xyz789"
    }
  }
}

clientPortalTicket

Response

Returns a Ticket

Arguments
Name Description
_id - String!

Example

Query
query ClientPortalTicket($_id: String!) {
  clientPortalTicket(_id: $_id) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reminderMinute
    score
    source
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "clientPortalTicket": {
      "_id": "xyz789",
      "assignedUserIds": ["abc123"],
      "assignedUsers": [User],
      "attachments": [Attachment],
      "boardId": "abc123",
      "closeDate": "2007-12-03",
      "companies": [Company],
      "createdAt": "2007-12-03",
      "createdUser": User,
      "customFieldsData": {},
      "customers": [Customer],
      "description": "abc123",
      "hasNotified": false,
      "isComplete": true,
      "isWatched": false,
      "labelIds": ["xyz789"],
      "labels": [PipelineLabel],
      "modifiedAt": "2007-12-03",
      "modifiedBy": "abc123",
      "name": "xyz789",
      "number": "xyz789",
      "order": 987.65,
      "pipeline": Pipeline,
      "priority": "xyz789",
      "reminderMinute": 987,
      "score": 123.45,
      "source": "abc123",
      "stage": Stage,
      "stageId": "xyz789",
      "startDate": "2007-12-03",
      "status": "xyz789",
      "timeTrack": TimeTrack,
      "userId": "abc123"
    }
  }
}

clientPortalTickets

Response

Returns [Ticket]

Arguments
Name Description
email - String!

Example

Query
query ClientPortalTickets($email: String!) {
  clientPortalTickets(email: $email) {
    _id
    assignedUserIds
    assignedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    attachments {
      duration
      name
      size
      type
      url
    }
    boardId
    closeDate
    companies {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    createdAt
    createdUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    hasNotified
    isComplete
    isWatched
    labelIds
    labels {
      _id
      colorCode
      createdAt
      createdBy
      name
      pipelineId
    }
    modifiedAt
    modifiedBy
    name
    number
    order
    pipeline {
      _id
      bgColor
      boardId
      createdAt
      createdUser {
        ...UserFragment
      }
      departmentIds
      endDate
      excludeCheckUserIds
      hackScoringType
      isCheckDepartment
      isCheckUser
      isWatched
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      metric
      name
      numberConfig
      numberSize
      order
      startDate
      state
      status
      templateId
      type
      userId
      visibility
    }
    priority
    reminderMinute
    score
    source
    stage {
      _id
      age
      amount
      code
      compareNextStage
      createdAt
      departmentIds
      formId
      inProcessDealsTotalCount
      initialDealsTotalCount
      itemsTotalCount
      memberIds
      members {
        ...UserFragment
      }
      name
      order
      pipelineId
      probability
      status
      stayedDealsTotalCount
      type
      visibility
    }
    stageId
    startDate
    status
    timeTrack {
      startDate
      status
      timeSpent
    }
    userId
  }
}
Variables
{"email": "xyz789"}
Response
{
  "data": {
    "clientPortalTickets": [
      {
        "_id": "xyz789",
        "assignedUserIds": ["abc123"],
        "assignedUsers": [User],
        "attachments": [Attachment],
        "boardId": "xyz789",
        "closeDate": "2007-12-03",
        "companies": [Company],
        "createdAt": "2007-12-03",
        "createdUser": User,
        "customFieldsData": {},
        "customers": [Customer],
        "description": "abc123",
        "hasNotified": false,
        "isComplete": false,
        "isWatched": true,
        "labelIds": ["abc123"],
        "labels": [PipelineLabel],
        "modifiedAt": "2007-12-03",
        "modifiedBy": "xyz789",
        "name": "abc123",
        "number": "xyz789",
        "order": 987.65,
        "pipeline": Pipeline,
        "priority": "xyz789",
        "reminderMinute": 123,
        "score": 987.65,
        "source": "abc123",
        "stage": Stage,
        "stageId": "xyz789",
        "startDate": "2007-12-03",
        "status": "xyz789",
        "timeTrack": TimeTrack,
        "userId": "xyz789"
      }
    ]
  }
}

clientPortalUserCounts

Response

Returns an Int

Arguments
Name Description
type - String

Example

Query
query ClientPortalUserCounts($type: String) {
  clientPortalUserCounts(type: $type)
}
Variables
{"type": "abc123"}
Response
{"data": {"clientPortalUserCounts": 123}}

clientPortalUserDetail

Response

Returns a ClientPortalUser

Arguments
Name Description
_id - String!

Example

Query
query ClientPortalUserDetail($_id: String!) {
  clientPortalUserDetail(_id: $_id) {
    _id
    clientPortalId
    code
    createdAt
    customFieldsData
    email
    erxesCustomerId
    firstName
    lastName
    links
    modifiedAt
    ownerId
    password
    phone
    type
    username
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "clientPortalUserDetail": {
      "_id": "abc123",
      "clientPortalId": "abc123",
      "code": "abc123",
      "createdAt": "2007-12-03",
      "customFieldsData": {},
      "email": "abc123",
      "erxesCustomerId": "abc123",
      "firstName": "xyz789",
      "lastName": "abc123",
      "links": {},
      "modifiedAt": "2007-12-03",
      "ownerId": "xyz789",
      "password": "abc123",
      "phone": "abc123",
      "type": "xyz789",
      "username": "xyz789"
    }
  }
}

clientPortalUsers

Response

Returns [ClientPortalUser]

Arguments
Name Description
conformityIsRelated - Boolean
conformityIsSaved - Boolean
conformityMainType - String
conformityMainTypeId - String
conformityRelType - String
cpId - String
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
sortDirection - Int
sortField - String
type - String

Example

Query
query ClientPortalUsers(
  $conformityIsRelated: Boolean,
  $conformityIsSaved: Boolean,
  $conformityMainType: String,
  $conformityMainTypeId: String,
  $conformityRelType: String,
  $cpId: String,
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $sortDirection: Int,
  $sortField: String,
  $type: String
) {
  clientPortalUsers(
    conformityIsRelated: $conformityIsRelated,
    conformityIsSaved: $conformityIsSaved,
    conformityMainType: $conformityMainType,
    conformityMainTypeId: $conformityMainTypeId,
    conformityRelType: $conformityRelType,
    cpId: $cpId,
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    sortDirection: $sortDirection,
    sortField: $sortField,
    type: $type
  ) {
    _id
    clientPortalId
    code
    createdAt
    customFieldsData
    email
    erxesCustomerId
    firstName
    lastName
    links
    modifiedAt
    ownerId
    password
    phone
    type
    username
  }
}
Variables
{
  "conformityIsRelated": true,
  "conformityIsSaved": true,
  "conformityMainType": "abc123",
  "conformityMainTypeId": "xyz789",
  "conformityRelType": "xyz789",
  "cpId": "xyz789",
  "excludeIds": true,
  "ids": ["xyz789"],
  "page": 987,
  "perPage": 123,
  "searchValue": "abc123",
  "sortDirection": 987,
  "sortField": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "clientPortalUsers": [
      {
        "_id": "abc123",
        "clientPortalId": "xyz789",
        "code": "xyz789",
        "createdAt": "2007-12-03",
        "customFieldsData": {},
        "email": "xyz789",
        "erxesCustomerId": "xyz789",
        "firstName": "xyz789",
        "lastName": "abc123",
        "links": {},
        "modifiedAt": "2007-12-03",
        "ownerId": "abc123",
        "password": "abc123",
        "phone": "xyz789",
        "type": "abc123",
        "username": "abc123"
      }
    ]
  }
}

clientPortalUsersMain

Response

Returns a clientPortalUsersListResponse

Arguments
Name Description
conformityIsRelated - Boolean
conformityIsSaved - Boolean
conformityMainType - String
conformityMainTypeId - String
conformityRelType - String
cpId - String
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
sortDirection - Int
sortField - String
type - String

Example

Query
query ClientPortalUsersMain(
  $conformityIsRelated: Boolean,
  $conformityIsSaved: Boolean,
  $conformityMainType: String,
  $conformityMainTypeId: String,
  $conformityRelType: String,
  $cpId: String,
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $sortDirection: Int,
  $sortField: String,
  $type: String
) {
  clientPortalUsersMain(
    conformityIsRelated: $conformityIsRelated,
    conformityIsSaved: $conformityIsSaved,
    conformityMainType: $conformityMainType,
    conformityMainTypeId: $conformityMainTypeId,
    conformityRelType: $conformityRelType,
    cpId: $cpId,
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    sortDirection: $sortDirection,
    sortField: $sortField,
    type: $type
  ) {
    list {
      _id
      clientPortalId
      code
      createdAt
      customFieldsData
      email
      erxesCustomerId
      firstName
      lastName
      links
      modifiedAt
      ownerId
      password
      phone
      type
      username
    }
    totalCount
  }
}
Variables
{
  "conformityIsRelated": true,
  "conformityIsSaved": false,
  "conformityMainType": "xyz789",
  "conformityMainTypeId": "abc123",
  "conformityRelType": "xyz789",
  "cpId": "xyz789",
  "excludeIds": true,
  "ids": ["xyz789"],
  "page": 123,
  "perPage": 987,
  "searchValue": "abc123",
  "sortDirection": 123,
  "sortField": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "clientPortalUsersMain": {
      "list": [ClientPortalUser],
      "totalCount": 987.65
    }
  }
}

commentCount

Response

Returns an Int

Arguments
Name Description
contentId - String!
contentType - ReactionContentType!

Example

Query
query CommentCount(
  $contentId: String!,
  $contentType: ReactionContentType!
) {
  commentCount(
    contentId: $contentId,
    contentType: $contentType
  )
}
Variables
{
  "contentId": "abc123",
  "contentType": "exmFeed"
}
Response
{"data": {"commentCount": 123}}

comments

Response

Returns a CommentResponse

Arguments
Name Description
contentId - String!
contentType - ReactionContentType!
limit - Int
parentId - String
skip - Int

Example

Query
query Comments(
  $contentId: String!,
  $contentType: ReactionContentType!,
  $limit: Int,
  $parentId: String,
  $skip: Int
) {
  comments(
    contentId: $contentId,
    contentType: $contentType,
    limit: $limit,
    parentId: $parentId,
    skip: $skip
  ) {
    list {
      _id
      childCount
      comment
      contentId
      contentType
      createdAt
      createdUser {
        ...UserFragment
      }
      parentId
      updatedAt
    }
    totalCount
  }
}
Variables
{
  "contentId": "abc123",
  "contentType": "exmFeed",
  "limit": 123,
  "parentId": "abc123",
  "skip": 123
}
Response
{
  "data": {
    "comments": {"list": [Comment], "totalCount": 123}
  }
}

companies

Response

Returns [Company]

Arguments
Name Description
autoCompletion - Boolean
autoCompletionType - String
brand - String
conformityIsRelated - Boolean
conformityIsSaved - Boolean
conformityMainType - String
conformityMainTypeId - String
conformityRelType - String
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
segment - String
sortDirection - Int
sortField - String
tag - String

Example

Query
query Companies(
  $autoCompletion: Boolean,
  $autoCompletionType: String,
  $brand: String,
  $conformityIsRelated: Boolean,
  $conformityIsSaved: Boolean,
  $conformityMainType: String,
  $conformityMainTypeId: String,
  $conformityRelType: String,
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $segment: String,
  $sortDirection: Int,
  $sortField: String,
  $tag: String
) {
  companies(
    autoCompletion: $autoCompletion,
    autoCompletionType: $autoCompletionType,
    brand: $brand,
    conformityIsRelated: $conformityIsRelated,
    conformityIsSaved: $conformityIsSaved,
    conformityMainType: $conformityMainType,
    conformityMainTypeId: $conformityMainTypeId,
    conformityRelType: $conformityRelType,
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    segment: $segment,
    sortDirection: $sortDirection,
    sortField: $sortField,
    tag: $tag
  ) {
    _id
    avatar
    businessType
    code
    createdAt
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    emails
    getTags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    industry
    isSubscribed
    links
    location
    mergedIds
    modifiedAt
    names
    owner {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    ownerId
    parentCompany {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    parentCompanyId
    phones
    plan
    primaryEmail
    primaryName
    primaryPhone
    score
    size
    tagIds
    trackedData
    website
  }
}
Variables
{
  "autoCompletion": true,
  "autoCompletionType": "abc123",
  "brand": "abc123",
  "conformityIsRelated": false,
  "conformityIsSaved": false,
  "conformityMainType": "abc123",
  "conformityMainTypeId": "abc123",
  "conformityRelType": "xyz789",
  "excludeIds": true,
  "ids": ["xyz789"],
  "page": 123,
  "perPage": 987,
  "searchValue": "abc123",
  "segment": "xyz789",
  "sortDirection": 123,
  "sortField": "xyz789",
  "tag": "abc123"
}
Response
{
  "data": {
    "companies": [
      {
        "_id": "xyz789",
        "avatar": "xyz789",
        "businessType": "xyz789",
        "code": "xyz789",
        "createdAt": "2007-12-03",
        "customFieldsData": {},
        "customers": [Customer],
        "description": "xyz789",
        "emails": ["xyz789"],
        "getTags": [Tag],
        "industry": "abc123",
        "isSubscribed": "abc123",
        "links": {},
        "location": "xyz789",
        "mergedIds": ["abc123"],
        "modifiedAt": "2007-12-03",
        "names": ["xyz789"],
        "owner": User,
        "ownerId": "abc123",
        "parentCompany": Company,
        "parentCompanyId": "xyz789",
        "phones": ["abc123"],
        "plan": "xyz789",
        "primaryEmail": "abc123",
        "primaryName": "xyz789",
        "primaryPhone": "xyz789",
        "score": 987.65,
        "size": 123,
        "tagIds": ["xyz789"],
        "trackedData": {},
        "website": "xyz789"
      }
    ]
  }
}

companiesMain

Response

Returns a CompaniesListResponse

Arguments
Name Description
autoCompletion - Boolean
autoCompletionType - String
brand - String
conformityIsRelated - Boolean
conformityIsSaved - Boolean
conformityMainType - String
conformityMainTypeId - String
conformityRelType - String
excludeIds - Boolean
ids - [String]
page - Int
perPage - Int
searchValue - String
segment - String
sortDirection - Int
sortField - String
tag - String

Example

Query
query CompaniesMain(
  $autoCompletion: Boolean,
  $autoCompletionType: String,
  $brand: String,
  $conformityIsRelated: Boolean,
  $conformityIsSaved: Boolean,
  $conformityMainType: String,
  $conformityMainTypeId: String,
  $conformityRelType: String,
  $excludeIds: Boolean,
  $ids: [String],
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $segment: String,
  $sortDirection: Int,
  $sortField: String,
  $tag: String
) {
  companiesMain(
    autoCompletion: $autoCompletion,
    autoCompletionType: $autoCompletionType,
    brand: $brand,
    conformityIsRelated: $conformityIsRelated,
    conformityIsSaved: $conformityIsSaved,
    conformityMainType: $conformityMainType,
    conformityMainTypeId: $conformityMainTypeId,
    conformityRelType: $conformityRelType,
    excludeIds: $excludeIds,
    ids: $ids,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    segment: $segment,
    sortDirection: $sortDirection,
    sortField: $sortField,
    tag: $tag
  ) {
    list {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    totalCount
  }
}
Variables
{
  "autoCompletion": false,
  "autoCompletionType": "abc123",
  "brand": "abc123",
  "conformityIsRelated": false,
  "conformityIsSaved": true,
  "conformityMainType": "xyz789",
  "conformityMainTypeId": "abc123",
  "conformityRelType": "xyz789",
  "excludeIds": false,
  "ids": ["xyz789"],
  "page": 123,
  "perPage": 123,
  "searchValue": "abc123",
  "segment": "abc123",
  "sortDirection": 987,
  "sortField": "abc123",
  "tag": "abc123"
}
Response
{
  "data": {
    "companiesMain": {
      "list": [Company],
      "totalCount": 123.45
    }
  }
}

companyCounts

Response

Returns a JSON

Arguments
Name Description
autoCompletion - Boolean
autoCompletionType - String
brand - String
conformityIsRelated - Boolean
conformityIsSaved - Boolean
conformityMainType - String
conformityMainTypeId - String
conformityRelType - String
excludeIds - Boolean
ids - [String]
only - String
page - Int
perPage - Int
searchValue - String
segment - String
sortDirection - Int
sortField - String
tag - String

Example

Query
query CompanyCounts(
  $autoCompletion: Boolean,
  $autoCompletionType: String,
  $brand: String,
  $conformityIsRelated: Boolean,
  $conformityIsSaved: Boolean,
  $conformityMainType: String,
  $conformityMainTypeId: String,
  $conformityRelType: String,
  $excludeIds: Boolean,
  $ids: [String],
  $only: String,
  $page: Int,
  $perPage: Int,
  $searchValue: String,
  $segment: String,
  $sortDirection: Int,
  $sortField: String,
  $tag: String
) {
  companyCounts(
    autoCompletion: $autoCompletion,
    autoCompletionType: $autoCompletionType,
    brand: $brand,
    conformityIsRelated: $conformityIsRelated,
    conformityIsSaved: $conformityIsSaved,
    conformityMainType: $conformityMainType,
    conformityMainTypeId: $conformityMainTypeId,
    conformityRelType: $conformityRelType,
    excludeIds: $excludeIds,
    ids: $ids,
    only: $only,
    page: $page,
    perPage: $perPage,
    searchValue: $searchValue,
    segment: $segment,
    sortDirection: $sortDirection,
    sortField: $sortField,
    tag: $tag
  )
}
Variables
{
  "autoCompletion": false,
  "autoCompletionType": "xyz789",
  "brand": "abc123",
  "conformityIsRelated": false,
  "conformityIsSaved": false,
  "conformityMainType": "xyz789",
  "conformityMainTypeId": "xyz789",
  "conformityRelType": "xyz789",
  "excludeIds": true,
  "ids": ["xyz789"],
  "only": "xyz789",
  "page": 987,
  "perPage": 987,
  "searchValue": "abc123",
  "segment": "xyz789",
  "sortDirection": 123,
  "sortField": "abc123",
  "tag": "abc123"
}
Response
{"data": {"companyCounts": {}}}

companyDetail

Response

Returns a Company

Arguments
Name Description
_id - String!

Example

Query
query CompanyDetail($_id: String!) {
  companyDetail(_id: $_id) {
    _id
    avatar
    businessType
    code
    createdAt
    customFieldsData
    customers {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    description
    emails
    getTags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    industry
    isSubscribed
    links
    location
    mergedIds
    modifiedAt
    names
    owner {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    ownerId
    parentCompany {
      _id
      avatar
      businessType
      code
      createdAt
      customFieldsData
      customers {
        ...CustomerFragment
      }
      description
      emails
      getTags {
        ...TagFragment
      }
      industry
      isSubscribed
      links
      location
      mergedIds
      modifiedAt
      names
      owner {
        ...UserFragment
      }
      ownerId
      parentCompany {
        ...CompanyFragment
      }
      parentCompanyId
      phones
      plan
      primaryEmail
      primaryName
      primaryPhone
      score
      size
      tagIds
      trackedData
      website
    }
    parentCompanyId
    phones
    plan
    primaryEmail
    primaryName
    primaryPhone
    score
    size
    tagIds
    trackedData
    website
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "companyDetail": {
      "_id": "abc123",
      "avatar": "xyz789",
      "businessType": "xyz789",
      "code": "xyz789",
      "createdAt": "2007-12-03",
      "customFieldsData": {},
      "customers": [Customer],
      "description": "xyz789",
      "emails": ["abc123"],
      "getTags": [Tag],
      "industry": "xyz789",
      "isSubscribed": "abc123",
      "links": {},
      "location": "xyz789",
      "mergedIds": ["abc123"],
      "modifiedAt": "2007-12-03",
      "names": ["abc123"],
      "owner": User,
      "ownerId": "abc123",
      "parentCompany": Company,
      "parentCompanyId": "abc123",
      "phones": ["abc123"],
      "plan": "abc123",
      "primaryEmail": "xyz789",
      "primaryName": "abc123",
      "primaryPhone": "abc123",
      "score": 987.65,
      "size": 123,
      "tagIds": ["xyz789"],
      "trackedData": {},
      "website": "xyz789"
    }
  }
}

configs

Response

Returns [Config]

Example

Query
query Configs {
  configs {
    _id
    code
    value
  }
}
Response
{
  "data": {
    "configs": [
      {
        "_id": "xyz789",
        "code": "xyz789",
        "value": {}
      }
    ]
  }
}

configsCheckActivateInstallation

Response

Returns a JSON

Arguments
Name Description
hostname - String!

Example

Query
query ConfigsCheckActivateInstallation($hostname: String!) {
  configsCheckActivateInstallation(hostname: $hostname)
}
Variables
{"hostname": "abc123"}
Response
{"data": {"configsCheckActivateInstallation": {}}}

configsCheckPremiumService

Response

Returns a Boolean

Arguments
Name Description
type - String!

Example

Query
query ConfigsCheckPremiumService($type: String!) {
  configsCheckPremiumService(type: $type)
}
Variables
{"type": "abc123"}
Response
{"data": {"configsCheckPremiumService": false}}

configsConstants

Response

Returns a JSON

Example

Query
query ConfigsConstants {
  configsConstants
}
Response
{"data": {"configsConstants": {}}}

configsGetEmailTemplate

Response

Returns a String

Arguments
Name Description
name - String

Example

Query
query ConfigsGetEmailTemplate($name: String) {
  configsGetEmailTemplate(name: $name)
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "configsGetEmailTemplate": "xyz789"
  }
}

configsGetEnv

Response

Returns an ENV

Example

Query
query ConfigsGetEnv {
  configsGetEnv {
    USE_BRAND_RESTRICTIONS
  }
}
Response
{
  "data": {
    "configsGetEnv": {
      "USE_BRAND_RESTRICTIONS": "xyz789"
    }
  }
}

configsGetValue

Response

Returns a JSON

Arguments
Name Description
code - String!

Example

Query
query ConfigsGetValue($code: String!) {
  configsGetValue(code: $code)
}
Variables
{"code": "abc123"}
Response
{"data": {"configsGetValue": {}}}

configsGetVersion

Response

Returns a JSON

Arguments
Name Description
releaseNotes - Boolean

Example

Query
query ConfigsGetVersion($releaseNotes: Boolean) {
  configsGetVersion(releaseNotes: $releaseNotes)
}
Variables
{"releaseNotes": false}
Response
{"data": {"configsGetVersion": {}}}

contactsLogs

Response

Returns a JSON

Arguments
Name Description
action - String
content - JSON
contentId - String
contentType - String

Example

Query
query ContactsLogs(
  $action: String,
  $content: JSON,
  $contentId: String,
  $contentType: String
) {
  contactsLogs(
    action: $action,
    content: $content,
    contentId: $contentId,
    contentType: $contentType
  )
}
Variables
{
  "action": "abc123",
  "content": {},
  "contentId": "abc123",
  "contentType": "xyz789"
}
Response
{"data": {"contactsLogs": {}}}

conversationCounts

Response

Returns a JSON

Arguments
Name Description
awaitingResponse - String
brandId - String
channelId - String
endDate - String
ids - [String]
integrationType - String
limit - Int
only - String
participating - String
segment - String
starred - String
startDate - String
status - String
tag - String
unassigned - String

Example

Query
query ConversationCounts(
  $awaitingResponse: String,
  $brandId: String,
  $channelId: String,
  $endDate: String,
  $ids: [String],
  $integrationType: String,
  $limit: Int,
  $only: String,
  $participating: String,
  $segment: String,
  $starred: String,
  $startDate: String,
  $status: String,
  $tag: String,
  $unassigned: String
) {
  conversationCounts(
    awaitingResponse: $awaitingResponse,
    brandId: $brandId,
    channelId: $channelId,
    endDate: $endDate,
    ids: $ids,
    integrationType: $integrationType,
    limit: $limit,
    only: $only,
    participating: $participating,
    segment: $segment,
    starred: $starred,
    startDate: $startDate,
    status: $status,
    tag: $tag,
    unassigned: $unassigned
  )
}
Variables
{
  "awaitingResponse": "abc123",
  "brandId": "abc123",
  "channelId": "abc123",
  "endDate": "abc123",
  "ids": ["abc123"],
  "integrationType": "xyz789",
  "limit": 123,
  "only": "abc123",
  "participating": "abc123",
  "segment": "abc123",
  "starred": "abc123",
  "startDate": "xyz789",
  "status": "xyz789",
  "tag": "xyz789",
  "unassigned": "abc123"
}
Response
{"data": {"conversationCounts": {}}}

conversationDetail

Response

Returns a Conversation

Arguments
Name Description
_id - String!

Example

Query
query ConversationDetail($_id: String!) {
  conversationDetail(_id: $_id) {
    _id
    assignedUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    assignedUserId
    bookingProductId
    callProAudio
    content
    createdAt
    customFieldsData
    customer {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    customerId
    facebookPost {
      attachments
      content
      erxesApiId
      permalink_url
      postId
      recipientId
      senderId
      timestamp
    }
    idleTime
    integration {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    integrationId
    isFacebookTaggedMessage
    messageCount
    messages {
      _id
      attachments {
        ...AttachmentFragment
      }
      bookingWidgetData
      botData
      content
      contentType
      conversationId
      createdAt
      customer {
        ...CustomerFragment
      }
      customerId
      engageData {
        ...EngageDataFragment
      }
      formWidgetData
      fromBot
      internal
      isCustomerRead
      mailData {
        ...MailDataFragment
      }
      mentionedUserIds
      messengerAppData
      user {
        ...UserFragment
      }
      userId
      videoCallData {
        ...VideoCallDataFragment
      }
    }
    number
    operatorStatus
    participatedUserIds
    participatedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    participatorCount
    readUserIds
    status
    tagIds
    tags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    updatedAt
    user {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    userId
    videoCallData {
      name
      recordingLinks
      status
      url
    }
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "conversationDetail": {
      "_id": "xyz789",
      "assignedUser": User,
      "assignedUserId": "xyz789",
      "bookingProductId": "abc123",
      "callProAudio": "abc123",
      "content": "xyz789",
      "createdAt": "2007-12-03",
      "customFieldsData": {},
      "customer": Customer,
      "customerId": "xyz789",
      "facebookPost": FacebookPost,
      "idleTime": 987.65,
      "integration": Integration,
      "integrationId": "abc123",
      "isFacebookTaggedMessage": false,
      "messageCount": 123,
      "messages": [ConversationMessage],
      "number": 123,
      "operatorStatus": "xyz789",
      "participatedUserIds": ["xyz789"],
      "participatedUsers": [User],
      "participatorCount": 123,
      "readUserIds": ["abc123"],
      "status": "xyz789",
      "tagIds": ["abc123"],
      "tags": [Tag],
      "updatedAt": "2007-12-03",
      "user": User,
      "userId": "abc123",
      "videoCallData": VideoCallData
    }
  }
}

conversationMessage

Response

Returns a ConversationMessage

Arguments
Name Description
_id - String!

Example

Query
query ConversationMessage($_id: String!) {
  conversationMessage(_id: $_id) {
    _id
    attachments {
      duration
      name
      size
      type
      url
    }
    bookingWidgetData
    botData
    content
    contentType
    conversationId
    createdAt
    customer {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    customerId
    engageData {
      brandId
      content
      fromUser {
        ...UserFragment
      }
      fromUserId
      kind
      messageId
      sentAs
    }
    formWidgetData
    fromBot
    internal
    isCustomerRead
    mailData {
      accountId
      attachments {
        ...MailAttachmentFragment
      }
      bcc {
        ...EmailFragment
      }
      body
      cc {
        ...EmailFragment
      }
      from {
        ...EmailFragment
      }
      headerId
      inReplyTo
      integrationEmail
      messageId
      references
      replyTo
      replyToMessageId
      subject
      threadId
      to {
        ...EmailFragment
      }
    }
    mentionedUserIds
    messengerAppData
    user {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    userId
    videoCallData {
      name
      recordingLinks
      status
      url
    }
  }
}
Variables
{"_id": "xyz789"}
Response
{
  "data": {
    "conversationMessage": {
      "_id": "abc123",
      "attachments": [Attachment],
      "bookingWidgetData": {},
      "botData": {},
      "content": "xyz789",
      "contentType": "abc123",
      "conversationId": "xyz789",
      "createdAt": "2007-12-03",
      "customer": Customer,
      "customerId": "xyz789",
      "engageData": EngageData,
      "formWidgetData": {},
      "fromBot": false,
      "internal": false,
      "isCustomerRead": false,
      "mailData": MailData,
      "mentionedUserIds": ["abc123"],
      "messengerAppData": {},
      "user": User,
      "userId": "abc123",
      "videoCallData": VideoCallData
    }
  }
}

conversationMessages

Response

Returns [ConversationMessage]

Arguments
Name Description
conversationId - String!
getFirst - Boolean
limit - Int
skip - Int

Example

Query
query ConversationMessages(
  $conversationId: String!,
  $getFirst: Boolean,
  $limit: Int,
  $skip: Int
) {
  conversationMessages(
    conversationId: $conversationId,
    getFirst: $getFirst,
    limit: $limit,
    skip: $skip
  ) {
    _id
    attachments {
      duration
      name
      size
      type
      url
    }
    bookingWidgetData
    botData
    content
    contentType
    conversationId
    createdAt
    customer {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    customerId
    engageData {
      brandId
      content
      fromUser {
        ...UserFragment
      }
      fromUserId
      kind
      messageId
      sentAs
    }
    formWidgetData
    fromBot
    internal
    isCustomerRead
    mailData {
      accountId
      attachments {
        ...MailAttachmentFragment
      }
      bcc {
        ...EmailFragment
      }
      body
      cc {
        ...EmailFragment
      }
      from {
        ...EmailFragment
      }
      headerId
      inReplyTo
      integrationEmail
      messageId
      references
      replyTo
      replyToMessageId
      subject
      threadId
      to {
        ...EmailFragment
      }
    }
    mentionedUserIds
    messengerAppData
    user {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    userId
    videoCallData {
      name
      recordingLinks
      status
      url
    }
  }
}
Variables
{
  "conversationId": "abc123",
  "getFirst": true,
  "limit": 987,
  "skip": 987
}
Response
{
  "data": {
    "conversationMessages": [
      {
        "_id": "xyz789",
        "attachments": [Attachment],
        "bookingWidgetData": {},
        "botData": {},
        "content": "abc123",
        "contentType": "xyz789",
        "conversationId": "xyz789",
        "createdAt": "2007-12-03",
        "customer": Customer,
        "customerId": "xyz789",
        "engageData": EngageData,
        "formWidgetData": {},
        "fromBot": false,
        "internal": false,
        "isCustomerRead": false,
        "mailData": MailData,
        "mentionedUserIds": ["xyz789"],
        "messengerAppData": {},
        "user": User,
        "userId": "xyz789",
        "videoCallData": VideoCallData
      }
    ]
  }
}

conversationMessagesTotalCount

Response

Returns an Int

Arguments
Name Description
conversationId - String!

Example

Query
query ConversationMessagesTotalCount($conversationId: String!) {
  conversationMessagesTotalCount(conversationId: $conversationId)
}
Variables
{"conversationId": "xyz789"}
Response
{"data": {"conversationMessagesTotalCount": 987}}

conversations

Response

Returns [Conversation]

Arguments
Name Description
awaitingResponse - String
brandId - String
channelId - String
endDate - String
ids - [String]
integrationType - String
limit - Int
participating - String
segment - String
starred - String
startDate - String
status - String
tag - String
unassigned - String

Example

Query
query Conversations(
  $awaitingResponse: String,
  $brandId: String,
  $channelId: String,
  $endDate: String,
  $ids: [String],
  $integrationType: String,
  $limit: Int,
  $participating: String,
  $segment: String,
  $starred: String,
  $startDate: String,
  $status: String,
  $tag: String,
  $unassigned: String
) {
  conversations(
    awaitingResponse: $awaitingResponse,
    brandId: $brandId,
    channelId: $channelId,
    endDate: $endDate,
    ids: $ids,
    integrationType: $integrationType,
    limit: $limit,
    participating: $participating,
    segment: $segment,
    starred: $starred,
    startDate: $startDate,
    status: $status,
    tag: $tag,
    unassigned: $unassigned
  ) {
    _id
    assignedUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    assignedUserId
    bookingProductId
    callProAudio
    content
    createdAt
    customFieldsData
    customer {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    customerId
    facebookPost {
      attachments
      content
      erxesApiId
      permalink_url
      postId
      recipientId
      senderId
      timestamp
    }
    idleTime
    integration {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    integrationId
    isFacebookTaggedMessage
    messageCount
    messages {
      _id
      attachments {
        ...AttachmentFragment
      }
      bookingWidgetData
      botData
      content
      contentType
      conversationId
      createdAt
      customer {
        ...CustomerFragment
      }
      customerId
      engageData {
        ...EngageDataFragment
      }
      formWidgetData
      fromBot
      internal
      isCustomerRead
      mailData {
        ...MailDataFragment
      }
      mentionedUserIds
      messengerAppData
      user {
        ...UserFragment
      }
      userId
      videoCallData {
        ...VideoCallDataFragment
      }
    }
    number
    operatorStatus
    participatedUserIds
    participatedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    participatorCount
    readUserIds
    status
    tagIds
    tags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    updatedAt
    user {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    userId
    videoCallData {
      name
      recordingLinks
      status
      url
    }
  }
}
Variables
{
  "awaitingResponse": "xyz789",
  "brandId": "xyz789",
  "channelId": "xyz789",
  "endDate": "abc123",
  "ids": ["xyz789"],
  "integrationType": "abc123",
  "limit": 123,
  "participating": "xyz789",
  "segment": "abc123",
  "starred": "abc123",
  "startDate": "xyz789",
  "status": "abc123",
  "tag": "xyz789",
  "unassigned": "xyz789"
}
Response
{
  "data": {
    "conversations": [
      {
        "_id": "xyz789",
        "assignedUser": User,
        "assignedUserId": "xyz789",
        "bookingProductId": "xyz789",
        "callProAudio": "xyz789",
        "content": "abc123",
        "createdAt": "2007-12-03",
        "customFieldsData": {},
        "customer": Customer,
        "customerId": "abc123",
        "facebookPost": FacebookPost,
        "idleTime": 123.45,
        "integration": Integration,
        "integrationId": "xyz789",
        "isFacebookTaggedMessage": true,
        "messageCount": 123,
        "messages": [ConversationMessage],
        "number": 987,
        "operatorStatus": "xyz789",
        "participatedUserIds": ["xyz789"],
        "participatedUsers": [User],
        "participatorCount": 987,
        "readUserIds": ["abc123"],
        "status": "xyz789",
        "tagIds": ["abc123"],
        "tags": [Tag],
        "updatedAt": "2007-12-03",
        "user": User,
        "userId": "xyz789",
        "videoCallData": VideoCallData
      }
    ]
  }
}

conversationsGetLast

Response

Returns a Conversation

Arguments
Name Description
awaitingResponse - String
brandId - String
channelId - String
endDate - String
ids - [String]
integrationType - String
limit - Int
participating - String
segment - String
starred - String
startDate - String
status - String
tag - String
unassigned - String

Example

Query
query ConversationsGetLast(
  $awaitingResponse: String,
  $brandId: String,
  $channelId: String,
  $endDate: String,
  $ids: [String],
  $integrationType: String,
  $limit: Int,
  $participating: String,
  $segment: String,
  $starred: String,
  $startDate: String,
  $status: String,
  $tag: String,
  $unassigned: String
) {
  conversationsGetLast(
    awaitingResponse: $awaitingResponse,
    brandId: $brandId,
    channelId: $channelId,
    endDate: $endDate,
    ids: $ids,
    integrationType: $integrationType,
    limit: $limit,
    participating: $participating,
    segment: $segment,
    starred: $starred,
    startDate: $startDate,
    status: $status,
    tag: $tag,
    unassigned: $unassigned
  ) {
    _id
    assignedUser {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    assignedUserId
    bookingProductId
    callProAudio
    content
    createdAt
    customFieldsData
    customer {
      _id
      avatar
      birthDate
      code
      companies {
        ...CompanyFragment
      }
      conversations {
        ...ConversationFragment
      }
      createdAt
      customFieldsData
      department
      description
      email
      emailValidationStatus
      emails
      firstName
      getTags {
        ...TagFragment
      }
      hasAuthority
      integration {
        ...IntegrationFragment
      }
      integrationId
      isOnline
      isSubscribed
      lastName
      lastSeenAt
      leadStatus
      links
      location
      middleName
      modifiedAt
      owner {
        ...UserFragment
      }
      ownerId
      phone
      phoneValidationStatus
      phones
      position
      primaryEmail
      primaryPhone
      remoteAddress
      score
      sessionCount
      sex
      state
      tagIds
      trackedData
      urlVisits
      visitorContactInfo
    }
    customerId
    facebookPost {
      attachments
      content
      erxesApiId
      permalink_url
      postId
      recipientId
      senderId
      timestamp
    }
    idleTime
    integration {
      _id
      bookingData {
        ...BookingDataFragment
      }
      brand {
        ...BrandFragment
      }
      brandId
      channels {
        ...ChannelFragment
      }
      code
      departmentIds
      form {
        ...FormFragment
      }
      formId
      healthStatus
      isActive
      kind
      knowledgeBaseMessengerApps {
        ...MessengerAppFragment
      }
      languageCode
      leadData
      leadMessengerApps {
        ...MessengerAppFragment
      }
      messengerData
      name
      tagIds
      tags {
        ...TagFragment
      }
      uiOptions
      visibility
      webhookData
      websiteMessengerApps {
        ...MessengerAppFragment
      }
    }
    integrationId
    isFacebookTaggedMessage
    messageCount
    messages {
      _id
      attachments {
        ...AttachmentFragment
      }
      bookingWidgetData
      botData
      content
      contentType
      conversationId
      createdAt
      customer {
        ...CustomerFragment
      }
      customerId
      engageData {
        ...EngageDataFragment
      }
      formWidgetData
      fromBot
      internal
      isCustomerRead
      mailData {
        ...MailDataFragment
      }
      mentionedUserIds
      messengerAppData
      user {
        ...UserFragment
      }
      userId
      videoCallData {
        ...VideoCallDataFragment
      }
    }
    number
    operatorStatus
    participatedUserIds
    participatedUsers {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    participatorCount
    readUserIds
    status
    tagIds
    tags {
      _id
      colorCode
      createdAt
      name
      objectCount
      order
      parentId
      relatedIds
      totalObjectCount
      type
    }
    updatedAt
    user {
      _id
      brandIds
      brands {
        ...BrandFragment
      }
      configs
      configsConstants
      createdAt
      customFieldsData
      department {
        ...DepartmentFragment
      }
      details {
        ...UserDetailsTypeFragment
      }
      email
      emailSignatures
      getNotificationByEmail
      groupIds
      isActive
      isOwner
      isShowNotification
      isSubscribed
      leaderBoardPosition
      links
      onboardingHistory {
        ...OnboardingHistoryFragment
      }
      permissionActions
      score
      status
      username
    }
    userId
    videoCallData {
      name
      recordingLinks
      status
      url
    }
  }
}
Variables
{
  "awaitingResponse": "xyz789",
  "brandId": "abc123",
  "channelId": "xyz789",
  "endDate": "xyz789",
  "ids": ["abc123"],
  "integrationType": "abc123",
  "limit": 987,
  "participating": "xyz789",
  "segment": "xyz789",
  "starred": "abc123",
  "startDate": "abc123",
  "status": "abc123",
  "tag": "xyz789",
  "unassigned": "abc123"
}
Response
{
  "data": {
    "conversationsGetLast": {
      "_id": "xyz789",
      "assignedUser": User,
      "assignedUserId": "abc123",
      "bookingProductId": "xyz789",
      "callProAudio": "xyz789",
      "content": "xyz789",
      "createdAt": "2007-12-03",
      "customFieldsData": {},
      "customer": Customer,
      "customerId": "xyz789",
      "facebookPost": FacebookPost,
      "idleTime": 123.45,
      "integration": Integration,
      "integrationId": "xyz789",
      "isFacebookTaggedMessage": false,
      "messageCount": 987,
      "messages": [ConversationMessage],
      "number": 987,
      "operatorStatus": "xyz789",
      "participatedUserIds": ["abc123"],
      "participatedUsers": [User],
      "participatorCount": 987,
      "readUserIds": ["abc123"],
      "status": "xyz789",
      "tagIds": ["xyz789"],
      "tags": [Tag],
      "updatedAt": "2007-12-03",
      "user": User,
      "userId": "xyz789",
      "videoCallData": VideoCallData
    }
  }
}

conversationsTotalCount

Response

Returns an Int

Arguments
Name Description
awaitingResponse - String
brandId - String
channelId - String
endDate - String
ids - [String]
integrationType - String
limit - Int
participating - String
segment - String
starred - String
startDate - String
status - String
tag - String
unassigned - String

Example

Query
query ConversationsTotalCount(
  $awaitingResponse: String,
  $brandId: String,
  $channelId: String,
  $endDate: String,
  $ids: [String],
  $integrationType: String,
  $limit: Int,
  $participating: String,
  $segment: String,
  $starred: String,
  $startDate: String,
  $status: String,
  $tag: String,
  $unassigned: String
) {
  conversationsTotalCount(
    awaitingResponse: $awaitingResponse,
    brandId: $brandId,
    channelId: $channelId,
    endDate: $endDate,
    ids: $ids,
    integrationType: $integrationType,
    limit: $limit,
    participating: $participating,
    segment: $segment,
    starred: $starred,
    startDate: $startDate,
    status: $status,
    tag: $tag,
    unassigned: $unassigned
  )
}
Variables
{
  "awaitingResponse": "abc123",
  "brandId": "xyz789",
  "channelId": "xyz789",
  "endDate": "abc123",
  "ids": ["xyz789"],
  "integrationType": "xyz789",
  "limit": 987,
  "participating": "xyz789",
  "segment": "xyz789",
  "starred": "xyz789",
  "startDate": "abc123",
  "status": "xyz789",
  "tag": "xyz789",
  "unassigned": "abc123"
}
Response
{"data": {"conversationsTotalCount": 987}}

conversationsTotalUnreadCount

Response

Returns an Int

Example

Query
query ConversationsTotalUnreadCount {
  conversationsTotalUnreadCount
}
Response
{"data": {"conversationsTotalUnreadCount": 123}}

convertToInfo

Response

Returns a ConvertTo

Arguments
Name Description
conversationId - String!

Example

Query
query ConvertToInfo($conversationId: String!) {
  convertToInfo(conversationId: $conversationId) {
    dealUrl
    taskUrl
    ticketUrl
  }
}
Variables
{"conversationId": "abc123"}
Response
{
  "data": {
    "convertToInfo": {
      "dealUrl": "abc123",
      "taskUrl": "xyz789",
      "ticketUrl": "xyz789"
    }
  }
}

cpDonateCampaigns

Response

Returns [DonateCampaign]

Example

Query
query CpDonateCampaigns {
  cpDonateCampaigns {
    _id
    attachment {
      duration
      name
      size
      type
      url
    }
    awards
    createdAt
    createdBy
    description
    donatesCount
    endDate
    finishDateOfUse
    maxScore
    modifiedAt
    modifiedBy
    startDate
    status
    title
  }
}
Response
{
  "data": {
    "cpDonateCampaigns": [
      {