Objects

Absence

Fields

Name
_id
Type
String
Description
Name
attachment
Type
Attachment
Description
Name
endTime
Type
Date
Description
Name
explanation
Type
String
Description
Name
holidayName
Type
String
Description
Name
reason
Type
String
Description
Name
solved
Type
Boolean
Description
Name
startTime
Type
Date
Description
Name
status
Type
String
Description
Name
user
Type
User
Description

AbsenceType

Fields

Name
_id
Type
String
Description
Name
attachRequired
Type
Boolean
Description
Name
explRequired
Type
Boolean
Description
Name
name
Type
String
Description
Name
requestHoursPerDay
Type
Float
Description
Name
requestTimeType
Type
String
Description
Name
requestType
Type
String
Description
Name
shiftRequest
Type
Boolean
Description

Action

Fields

Name
config
Type
JSON
Description
Name
description
Type
String
Description
Name
icon
Type
String
Description
Name
id
Type
String
Description
Name
label
Type
String
Description
Name
nextActionId
Type
String
Description
Name
style
Type
JSON
Description
Name
type
Type
String
Description

ActivityLog

Fields

Name
_id
Type
String
Description
Name
action
Type
String
Description
Name
content
Type
JSON
Description
Name
contentDetail
Type
JSON
Description
Name
contentId
Type
String
Description
Name
contentType
Type
String
Description
Name
contentTypeDetail
Type
JSON
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdByDetail
Type
JSON
Description

ActivityLogByAction

Fields

Name
_id
Type
String
Description
Name
action
Type
String
Description
Name
content
Type
JSON
Description
Name
contentId
Type
String
Description
Name
contentType
Type
String
Description
Name
contentTypeDetail
Type
JSON
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdUser
Type
User
Description

ActivityLogByActionResponse

Fields

Name
activityLogs
Type
[ActivityLogByAction]
Description
Name
totalCount
Type
Int
Description

App

Fields

Name
_id
Type
String
Description
Name
accessToken
Type
String
Description
Name
createdAt
Type
Date
Description
Name
expireDate
Type
Date
Description
Name
isEnabled
Type
Boolean
Description
Name
name
Type
String
Description
Name
refreshToken
Type
String
Description
Name
userGroupId
Type
String
Description
Name
userGroupName
Type
String
Description

Asset

Fields

Name
_id
Type
String!
Description
Name
assetCount
Type
Int
Description
Name
attachment
Type
Attachment
Description
Name
attachmentMore
Type
[Attachment]
Description
Name
category
Type
AssetCategory
Description
Name
categoryId
Type
String
Description
Name
childAssetCount
Type
Int
Description
Name
code
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
description
Type
String
Description
Name
isRoot
Type
Boolean
Description
Name
kbArticleIds
Type
[String]
Description
Name
knowledgeData
Type
JSON
Description
Name
name
Type
String
Description
Name
order
Type
String
Description
Name
parent
Type
Asset
Description
Name
parentId
Type
String
Description
Name
unitPrice
Type
Float
Description
Name
vendor
Type
Company
Description
Name
vendorId
Type
String
Description

AssetCategory

Fields

Name
_id
Type
String!
Description
Name
assetCount
Type
Int
Description
Name
attachment
Type
Attachment
Description
Name
code
Type
String!
Description
Name
description
Type
String
Description
Name
isRoot
Type
Boolean
Description
Name
name
Type
String
Description
Name
order
Type
String!
Description
Name
parentId
Type
String
Description
Name
status
Type
String
Description

Assignment

Fields

Name
_id
Type
String
Description
Name
campaign
Type
JSON
Description
Name
campaignId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
owner
Type
JSON
Description
Name
ownerId
Type
String
Description
Name
ownerType
Type
String
Description
Name
segmentIds
Type
[String]
Description
Name
status
Type
String
Description
Name
usedAt
Type
Date
Description
Name
voucherCampaignId
Type
String
Description
Name
voucherId
Type
String
Description

AssignmentCampaign

Fields

Name
_id
Type
String
Description
Name
attachment
Type
Attachment
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
description
Type
String
Description
Name
endDate
Type
Date
Description
Name
finishDateOfUse
Type
Date
Description
Name
modifiedAt
Type
Date
Description
Name
modifiedBy
Type
String
Description
Name
segmentIds
Type
[String]
Description
Name
startDate
Type
Date
Description
Name
status
Type
String
Description
Name
title
Type
String
Description
Name
voucherCampaignId
Type
String
Description

AssignmentMain

Fields

Name
list
Type
[Assignment]
Description
Name
totalCount
Type
Int
Description

Attachment

Fields

Name
duration
Type
Float
Description
Name
name
Type
String
Description
Name
size
Type
Float
Description
Name
type
Type
String
Description
Name
url
Type
String!
Description

Automation

Fields

Name
_id
Type
String!
Description
Name
actions
Type
[Action]
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdUser
Type
User
Description
Name
name
Type
String
Description
Name
status
Type
String
Description
Name
triggers
Type
[Trigger]
Description
Name
updatedAt
Type
Date
Description
Name
updatedBy
Type
String
Description
Name
updatedUser
Type
User
Description

AutomationHistory

Fields

Name
_id
Type
String!
Description
Name
actions
Type
JSON
Description
Name
automationId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
description
Type
String
Description
Name
modifiedAt
Type
Date
Description
Name
nextActionId
Type
String
Description
Name
startWaitingDate
Type
Date
Description
Name
status
Type
String
Description
Name
target
Type
JSON
Description
Name
targetId
Type
String
Description
Name
triggerConfig
Type
JSON
Description
Name
triggerId
Type
String
Description
Name
triggerType
Type
String
Description
Name
waitingActionId
Type
String
Description

AutomationNote

Fields

Name
_id
Type
String!
Description
Name
actionId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
description
Type
String
Description
Name
triggerId
Type
String
Description

AutomationsListResponse

Fields

Name
list
Type
[Automation]
Description
Name
totalCount
Type
Float
Description

automationsTotalCountResponse

Fields

Name
byStatus
Type
Int
Description
Name
total
Type
Int
Description

AvgEmailStats

Fields

Name
avgBouncePercent
Type
Float
Description
Name
avgClickPercent
Type
Float
Description
Name
avgComplaintPercent
Type
Float
Description
Name
avgDeliveryPercent
Type
Float
Description
Name
avgOpenPercent
Type
Float
Description
Name
avgRejectPercent
Type
Float
Description
Name
avgRenderingFailurePercent
Type
Float
Description
Name
avgSendPercent
Type
Float
Description
Name
total
Type
Float
Description

Board

Fields

Name
_id
Type
String!
Description
Name
createdAt
Type
Date
Description
Name
name
Type
String
Description
Name
order
Type
Int
Description
Name
pipelines
Type
[Pipeline]
Description
Name
type
Type
String
Description

BoardCount

Fields

Name
_id
Type
String
Description
Name
count
Type
Int
Description
Name
name
Type
String
Description

BookingData

Fields

Name
bookingFormText
Type
String
Description
Name
categoryTree
Type
JSON
Description
Name
description
Type
String
Description
Name
displayBlock
Type
JSON
Description
Name
image
Type
Attachment
Description
Name
modifiedAt
Type
Date
Description
Name
mainProductCategory
Type
ProductCategory
Description
Name
name
Type
String
Description
Name
navigationText
Type
String
Description
Name
productCategoryId
Type
String
Description
Name
productFieldIds
Type
[String]
Description
Name
style
Type
JSON
Description
Name
userFilters
Type
[String]
Description
Name
viewCount
Type
Int
Description

BookingProduct

Fields

Name
fields
Type
[Field]
Description
Name
product
Type
Product
Description

Branch

Fields

Name
_id
Type
String!
Description
Name
address
Type
String
Description
Name
children
Type
Branch
Description
Name
code
Type
String
Description
Name
coordinate
Type
Coordinate
Description
Name
email
Type
String
Description
Name
image
Type
Attachment
Description
Name
links
Type
JSON
Description
Name
order
Type
String
Description
Name
parent
Type
Branch
Description
Name
parentId
Type
String
Description
Name
phoneNumber
Type
Int
Description
Name
radius
Type
Int
Description
Name
supervisor
Type
User
Description
Name
supervisorId
Type
String
Description
Name
title
Type
String
Description
Name
userCount
Type
Int
Description
Name
userIds
Type
String
Description
Name
users
Type
User
Description

BranchListQueryResponse

Fields

Name
list
Type
Branch
Description
Name
totalCount
Type
Int
Description
Name
totalUsersCount
Type
Int
Description

Brand

Fields

Name
_id
Type
String!
Description
Name
code
Type
String
Description
Name
createdAt
Type
Date
Description
Name
description
Type
String
Description
Name
emailConfig
Type
JSON
Description
Name
memberIds
Type
[String]
Description
Name
name
Type
String
Description
Name
userId
Type
String
Description

Callout

Fields

Name
body
Type
String
Description
Name
buttonText
Type
String
Description
Name
featuredImage
Type
String
Description
Name
skip
Type
Boolean
Description
Name
title
Type
String
Description

Channel

Fields

Name
_id
Type
String!
Description
Name
conversationCount
Type
Int
Description
Name
createdAt
Type
Date
Description
Name
description
Type
String
Description
Name
integrationIds
Type
[String]
Description
Name
integrations
Type
[Integration]
Description
Name
memberIds
Type
[String]
Description
Name
members
Type
[User]
Description
Name
name
Type
String!
Description
Name
openConversationCount
Type
Int
Description
Name
userId
Type
String!
Description

Chat

Fields

Name
_id
Type
String!
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
description
Type
String
Description
Name
isSeen
Type
Boolean
Description
Name
lastMessage
Type
ChatMessage
Description
Name
name
Type
String
Description
Name
participantUsers
Type
[ChatUser]
Description
Name
type
Type
String
Description
Name
visibility
Type
String
Description

ChatMessage

Fields

Name
_id
Type
String!
Description
Name
attachments
Type
JSON
Description
Name
content
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
isPinned
Type
Boolean
Description
Name
mentionedUserIds
Type
[String]
Description
Name
relatedMessage
Type
ChatMessage
Description
Name
seenList
Type
[SeenInfo]
Description

ChatMessageResponse

Fields

Name
list
Type
[ChatMessage]
Description
Name
totalCount
Type
Int
Description

ChatResponse

Fields

Name
list
Type
[Chat]
Description
Name
totalCount
Type
Int
Description

ChatTypingStatusChangedResponse

Fields

Name
chatId
Type
String!
Description
Name
userId
Type
String
Description

ChatUser

Fields

Name
_id
Type
String!
Description
Name
branches
Type
[Branch]
Description
Name
departments
Type
[Departments]
Description
Name
details
Type
ChatUserDetails
Description
Name
email
Type
String
Description
Name
employeeId
Type
String
Description
Name
isAdmin
Type
Boolean
Description
Name
username
Type
String
Description

ChatUserDetails

Fields

Name
avatar
Type
String
Description
Name
description
Type
String
Description
Name
fullName
Type
String
Description
Name
operatorPhone
Type
String
Description
Name
position
Type
String
Description

Checklist

Fields

Name
_id
Type
String!
Description
Name
contentType
Type
String
Description
Name
contentTypeId
Type
String
Description
Name
createdDate
Type
Date
Description
Name
createdUserId
Type
String
Description
Name
items
Type
[ChecklistItem]
Description
Name
percent
Type
Float
Description
Name
title
Type
String
Description

ChecklistItem

Fields

Name
_id
Type
String!
Description
Name
checklistId
Type
String
Description
Name
content
Type
String
Description
Name
isChecked
Type
Boolean
Description
Name
order
Type
Int
Description

CheckReport

Fields

Name
_id
Type
String!
Description
Name
endDate
Type
String
Description
Name
startDate
Type
String
Description
Name
userId
Type
Boolean
Description

ClientPortal

Fields

Name
_id
Type
String!
Description
Name
dealBoardId
Type
String
Description
Name
dealLabel
Type
String
Description
Name
dealPipelineId
Type
String
Description
Name
dealStageId
Type
Boolean
Description
Name
dealToggle
Type
Boolean
Description
Name
description
Type
String
Description
Name
dnsStatus
Type
String
Description
Name
domain
Type
String
Description
Name
footerHtml
Type
String
Description
Name
googleCredentials
Type
JSON
Description
Name
headerHtml
Type
String
Description
Name
icon
Type
String
Description
Name
kbToggle
Type
Boolean
Description
Name
knowledgeBaseLabel
Type
String
Description
Name
knowledgeBaseTopicId
Type
String
Description
Name
logo
Type
String
Description
Name
mailConfig
Type
[MailConfig]
Description
Name
manualVerificationConfig
Type
[manualVerificationConfig]
Description
Name
messengerBrandCode
Type
String
Description
Name
mobileResponsive
Type
Boolean
Description
Name
name
Type
String!
Description
Name
otpConfig
Type
[OtpConfig]
Description
Name
publicTaskToggle
Type
Boolean
Description
Name
styles
Type
String
Description
Name
taskBoardId
Type
String
Description
Name
taskLabel
Type
String
Description
Name
taskPipelineId
Type
String
Description
Name
taskPublicBoardId
Type
String
Description
Name
taskPublicPipelineId
Type
String
Description
Name
taskStageId
Type
String
Description
Name
taskToggle
Type
Boolean
Description
Name
ticketBoardId
Type
String
Description
Name
ticketLabel
Type
String
Description
Name
ticketPipelineId
Type
String
Description
Name
ticketStageId
Type
String
Description
Name
ticketToggle
Type
Boolean
Description
Name
url
Type
String
Description

ClientPortalComment

Fields

Name
_id
Type
String!
Description
Name
content
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
JSON
Description
Name
type
Type
String
Description
Name
typeId
Type
String
Description
Name
userId
Type
String
Description
Name
userType
Type
String
Description

ClientPortalNotification

Fields

Name
_id
Type
String!
Description
Name
clientPortalId
Type
String
Description
Name
content
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
eventData
Type
JSON
Description
Name
isRead
Type
Boolean
Description
Name
link
Type
String
Description
Name
notifType
Type
NotificationType
Description
Name
receiver
Type
String
Description
Name
title
Type
String
Description

ClientPortalUser

Fields

Name
_id
Type
String!
Description
Name
dealBoardId
Type
String
Description
Name
avatar
Type
ClientPortal
Description
Name
clientPortal
Type
String
Description
Name
clientPortalId
Type
Boolean
Description
Name
code
Type
Boolean
Description
Name
company
Type
Company
Description
Name
companyName
Type
String
Description
Name
companyRegistrationNumber
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
customFieldsDataByFieldCode
Type
JSON
Description
Name
customer
Type
Customer
Description
Name
email
Type
String
Description
Name
erxesCompanyId
Type
String
Description
Name
erxesCustomerId
Type
String
Description
Name
firstName
Type
String
Description
Name
isEmailVerified
Type
Boolean
Description
Name
isOnline
Type
Boolean
Description
Name
isPhoneVerified
Type
Boolean
Description
Name
lastName
Type
Boolean
Description
Name
lastSeenAt
Type
Date
Description
Name
links
Type
JSON
Description
Name
modifiedAt
Type
Date
Description
Name
notificationSettings
Type
UserNotificationSettings
Description
Name
ownerId
Type
String
Description
Name
password
Type
String
Description
Name
phone
Type
String
Description
Name
sessionCount
Type
Int
Description
Name
type
Type
String
Description
Name
username
Type
String
Description
Name
verificationRequest
Type
VerificationRequest
Description

clientPortalUsersListResponse

Fields

Name
list
Type
[ClientPortalUser]
Description
Name
totalCount
Type
Float
Description

ColumnConfigItem

Fields

Name
label
Type
String
Description
Name
name
Type
String
Description
Name
order
Type
Int
Description

Comment

Fields

Name
_id
Type
String
Description
Name
childCount
Type
Int
Description
Name
comment
Type
String
Description
Name
contentId
Type
String
Description
Name
contentType
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
parentId
Type
String
Description
Name
updatedAt
Type
Date
Description

CommentResponse

Fields

Name
list
Type
[Comment]
Description
Name
totalCount
Type
Int
Description

CompaniesListResponse

Fields

Name
list
Type
[Company]
Description
Name
totalCount
Type
Float
Description

Company

Fields

Name
_id
Type
String!
Description
Name
avatar
Type
String
Description
Name
businessType
Type
String
Description
Name
code
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
customFieldsDataByFieldCode
Type
JSON
Description
Name
customers
Type
[Customer]
Description
Name
description
Type
String
Description
Name
emails
Type
[String]
Description
Name
getTags
Type
[Tag]
Description
Name
industry
Type
String
Description
Name
isSubscribed
Type
String
Description
Name
links
Type
JSON
Description
Name
location
Type
String
Description
Name
mergedIds
Type
[String]
Description
Name
modifiedAt
Type
Date
Description
Name
names
Type
[String]
Description
Name
owner
Type
User
Description
Name
ownerId
Type
String
Description
Name
parentCompany
Type
Company
Description
Name
parentCompanyId
Type
String
Description
Name
phones
Type
[String]
Description
Name
plan
Type
String
Description
Name
primaryEmail
Type
String
Description
Name
primaryName
Type
String
Description
Name
primaryPhone
Type
String
Description
Name
score
Type
Float
Description
Name
size
Type
Int
Description
Name
tagIds
Type
[String]
Description
Name
trackedData
Type
JSON
Description
Name
website
Type
String
Description

Config

Fields

Name
_id
Type
String!
Description
Name
code
Type
String!
Description
Name
value
Type
JSON
Description

ConfigDay

Fields

Name
_id
Type
String!
Description
Name
configName
Type
String
Description
Name
configShiftEnd
Type
String
Description
Name
configShiftStart
Type
String
Description
Name
overnightShift
Type
Boolean
Description
Name
scheduleConfigId
Type
String
Description

Conformity

Fields

Name
_id
Type
String!
Description
Name
mainType
Type
String
Description
Name
mainTypeId
Type
String
Description
Name
relType
Type
String
Description
Name
relTypeId
Type
String
Description

Conversation

Fields

Name
_id
Type
String!
Description
Name
assignedUser
Type
User
Description
Name
assignedUserId
Type
String
Description
Name
bookingProductId
Type
String
Description
Name
callProAudio
Type
String
Description
Name
content
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
customer
Type
Customer
Description
Name
customerId
Type
String
Description
Name
idleTime
Type
Float
Description
Name
integration
Type
Integration
Description
Name
integrationId
Type
String
Description
Name
messageCount
Type
Int
Description
Name
messages
Type
[ConversationMessage]
Description
Name
number
Type
Int
Description
Name
operatorStatus
Type
String
Description
Name
participatedUserIds
Type
[String]
Description
Name
participatedUsers
Type
[User]
Description
Name
participatorCount
Type
Int
Description
Name
readUserIds
Type
[String]
Description
Name
status
Type
String
Description
Name
tagIds
Type
[String]
Description
Name
tags
Type
[Tag]
Description
Name
updatedAt
Type
Date
Description
Name
user
Type
User
Description
Name
userId
Type
String
Description
Name
videoCallData
Type
VideoCallData
Description

ConversationAdminMessageInsertedResponse

Fields

Name
customerId
Type
String
Description
Name
unreadCount
Type
Int
Description

ConversationChangedResponse

Fields

Name
conversationId
Type
String!
Description
Name
type
Type
String!
Description

ConversationClientTypingStatusChangedResponse

Fields

Name
conversationId
Type
String!
Description
Name
text
Type
String
Description

ConversationDetailResponse

Fields

Name
_id
Type
String
Description
Name
isOnline
Type
Boolean
Description
Name
messages
Type
[ConversationMessage]
Description
Name
operatorStatus
Type
String
Description
Name
participatedUsers
Type
[User]
Description
Name
supporters
Type
[User]
Description

ConversationMessage

Fields

Name
_id
Type
String!
Description
Name
attachments
Type
[Attachment]
Description
Name
bookingWidgetData
Type
JSON
Description
Name
botData
Type
JSON
Description
Name
content
Type
String
Description
Name
contentType
Type
String
Description
Name
conversationId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customer
Type
Customer
Description
Name
customerId
Type
String
Description
Name
engageData
Type
EngageData
Description
Name
formWidgetData
Type
JSON
Description
Name
fromBot
Type
Boolean
Description
Name
internal
Type
Boolean
Description
Name
isCustomerRead
Type
Boolean
Description
Name
mailData
Type
MailData
Description
Name
mentionedUserIds
Type
[String]
Description
Name
messengerAppData
Type
JSON
Description
Name
mid
Type
String
Description
Name
user
Type
[User]
Description
Name
userId
Type
String
Description
Name
videoCallData
Type
VideoCallData
Description

ConvertTo

Fields

Name
dealUrl
Type
String
Description
Name
taskUrl
Type
String
Description
Name
ticketUrl
Type
String
Description

Coordinate

Fields

Name
latitude
Type
String
Description
Name
longitude
Type
String
Description

Customer

Fields

Name
_id
Type
String!
Description
Name
avatar
Type
String
Description
Name
birthDate
Type
Date
Description
Name
code
Type
String
Description
Name
companies
Type
[Company]
Description
Name
conversations
Type
[Conversation]
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
customFieldsDataByFieldCode
Type
JSON
Description
Name
department
Type
String
Description
Name
description
Type
String
Description
Name
email
Type
String
Description
Name
emailValidationStatus
Type
String
Description
Name
emails
Type
[String]
Description
Name
firstName
Type
String
Description
Name
getTags
Type
[Tag]
Description
Name
hasAuthority
Type
String
Description
Name
integration
Type
[Integration]
Description
Name
integrationId
Type
String
Description
Name
isOnline
Type
Boolean
Description
Name
isSubscribed
Type
String
Description
Name
lastName
Type
String
Description
Name
lastSeenAt
Type
Date
Description
Name
leadStatus
Type
String
Description
Name
links
Type
JSON
Description
Name
location
Type
JSON
Description
Name
middleName
Type
String
Description
Name
modifiedAt
Type
Date
Description
Name
owner
Type
User
Description
Name
ownerId
Type
String
Description
Name
phone
Type
String
Description
Name
phoneValidationStatus
Type
String
Description
Name
phones
Type
[String]
Description
Name
position
Type
String
Description
Name
primaryEmail
Type
String
Description
Name
primaryPhone
Type
String
Description
Name
remoteAddress
Type
String
Description
Name
score
Type
Float
Description
Name
sessionCount
Type
Int
Description
Name
sex
Type
Int
Description
Name
state
Type
String
Description
Name
tagIds
Type
[String]
Description
Name
trackedData
Type
JSON
Description
Name
urlVisits
Type
[JSON]
Description
Name
visitorContactInfo
Type
JSON
Description

CustomerConnectionChangedResponse

Fields

Name
_id
Type
String!
Description
Name
status
Type
String!
Description

CustomersListResponse

Fields

Name
list
Type
[Customer]
Description
Name
totalCount
Type
Float
Description

Dashboard

Fields

Name
_id
Type
String!
Description
Name
childsDashboard
Type
[Dashboard]
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdUser
Type
User
Description
Name
dashboardCount
Type
Int
Description
Name
departmentIds
Type
[String]
Description
Name
description
Type
String
Description
Name
getTags
Type
[Tag]
Description
Name
itemsCount
Type
Int
Description
Name
members
Type
[User]
Description
Name
name
Type
String
Description
Name
order
Type
String
Description
Name
parentId
Type
String
Description
Name
relatedIds
Type
[String]
Description
Name
selectedMemberIds
Type
[String]
Description
Name
tagIds
Type
[String]
Description
Name
updatedAt
Type
Date
Description
Name
updatedBy
Type
String
Description
Name
updatedUser
Type
User
Description
Name
visibility
Type
String
Description

DashboardItem

Fields

Name
_id
Type
String!
Description
Name
dashboardId
Type
String
Description
Name
isDateRange
Type
Boolean
Description
Name
layout
Type
String
Description
Name
name
Type
String
Description
Name
type
Type
String
Description
Name
vizState
Type
String
Description

DashboardListResponse

Fields

Name
list
Type
[Dashboard]
Description
Name
totalCount
Type
Float
Description

Deal

Fields

Name
_id
Type
String!
Description
Name
amount
Type
JSON
Description
Name
assignedUserIds
Type
[String]
Description
Name
assignedUsers
Type
[User]
Description
Name
attachments
Type
[Attachment]
Description
Name
boardId
Type
String
Description
Name
branchIds
Type
[String]
Description
Name
closeDate
Type
Date
Description
Name
companies
Type
[Company]
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
customFieldsData
Type
JSON
Description
Name
customProperties
Type
JSON
Description
Name
customers
Type
[Customer]
Description
Name
departmentIds
Type
[String]
Description
Name
description
Type
String
Description
Name
hasNotified
Type
Boolean
Description
Name
isComplete
Type
Boolean
Description
Name
isWatched
Type
Boolean
Description
Name
labelIds
Type
[String]
Description
Name
labels
Type
[PipelineLabel]
Description
Name
modifiedAt
Type
Date
Description
Name
modifiedBy
Type
String
Description
Name
name
Type
String!
Description
Name
number
Type
String
Description
Name
order
Type
Float
Description
Name
paymentsData
Type
JSON
Description
Name
pipeline
Type
Pipeline
Description
Name
priority
Type
String
Description
Name
products
Type
JSON
Description
Name
productsData
Type
JSON
Description
Name
reminderMinute
Type
Int
Description
Name
score
Type
Float
Description
Name
stage
Type
[Stage]
Description
Name
stageChangedDate
Type
Date
Description
Name
stageId
Type
String
Description
Name
startDate
Type
Date
Description
Name
status
Type
String
Description
Name
tagIds
Type
[String]
Description
Name
tags
Type
[Tag]
Description
Name
timeTrack
Type
TimeTrack
Description
Name
userId
Type
String
Description

DealListItem

Fields

Name
_id
Type
String!
Description
Name
amount
Type
JSON
Description
Name
assignedUsers
Type
JSON
Description
Name
branchIds
Type
[String]
Description
Name
branches
Type
[Branch]
Description
Name
closeDate
Type
Date
Description
Name
companies
Type
JSON
Description
Name
createdAt
Type
Date
Description
Name
customFieldsData
Type
JSON
Description
Name
customProperties
Type
JSON
Description
Name
customers
Type
JSON
Description
Name
departmentIds
Type
[String]
Description
Name
departments
Type
[Department]
Description
Name
hasNotified
Type
Boolean
Description
Name
isComplete
Type
Boolean
Description
Name
isWatched
Type
Boolean
Description
Name
labels
Type
JSON
Description
Name
modifiedAt
Type
Date
Description
Name
name
Type
String
Description
Name
number
Type
String
Description
Name
priority
Type
JSON
Description
Name
products
Type
String
Description
Name
relations
Type
JSON
Description
Name
score
Type
Float
Description
Name
stage
Type
JSON
Description
Name
stageChangedDate
Type
Date
Description
Name
startDate
Type
Date
Description
Name
status
Type
String
Description
Name
tagIds
Type
[String]
Description

DealTotalCurrency

Fields

Name
amount
Type
Float
Description
Name
name
Type
String
Description

DeliveryList

Fields

Name
list
Type
[SmsDelivery]
Description
Name
totalCount
Type
Int
Description

DeliveryReport

Fields

Name
_id
Type
String!
Description
Name
createdAt
Type
Date
Description
Name
customerId
Type
String
Description
Name
customerName
Type
String
Description
Name
email
Type
String
Description
Name
engage
Type
EngageMessage
Description
Name
mailId
Type
String
Description
Name
status
Type
String
Description

Department

Fields

Name
_id
Type
String!
Description
Name
childCount
Type
Int
Description
Name
children
Type
[Department]
Description
Name
code
Type
String
Description
Name
description
Type
String
Description
Name
order
Type
String
Description
Name
parent
Type
Department
Description
Name
parentId
Type
String
Description
Name
supervisor
Type
User
Description
Name
supervisorId
Type
String
Description
Name
title
Type
String
Description
Name
userCount
Type
Int
Description
Name
userIds
Type
[String]
Description
Name
users
Type
[User]
Description

DepartmentListQueryResponse

Fields

Name
list
Type
[Department]
Description
Name
totalCount
Type
Int
Description
Name
totalUsersCount
Type
Int
Description

DeviceConfig

Fields

Name
_id
Type
String!
Description
Name
deviceName
Type
String
Description
Name
extractRequired
Type
Boolean
Description
Name
serialNo
Type
String
Description

DeviceConfigsListResponse

Fields

Name
list
Type
[DeviceConfig]
Description
Name
totalCount
Type
Float
Description

Document

Fields

Name
_id
Type
String!
Description
Name
content
Type
String
Description
Name
contentType
Type
String!
Description
Name
createdAt
Type
Date
Description
Name
createdUserId
Type
String
Description
Name
name
Type
String!
Description
Name
replacer
Type
String
Description

DocumentEditorAttribute

Fields

Name
name
Type
String
Description
Name
value
Type
String
Description

Donate

Fields

Name
_id
Type
String
Description
Name
awardId
Type
String
Description
Name
campaign
Type
JSON
Description
Name
campaignId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
donateScore
Type
Float
Description
Name
owner
Type
JSON
Description
Name
ownerId
Type
String
Description
Name
ownerType
Type
String
Description
Name
usedAt
Type
Date
Description
Name
voucherCampaignId
Type
String
Description
Name
voucherId
Type
String
Description

DonateCampaign

Fields

Name
_id
Type
String
Description
Name
attachment
Type
Attachment
Description
Name
awards
Type
JSON
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
description
Type
String
Description
Name
donatesCount
Type
Int
Description
Name
endDate
Type
Date
Description
Name
finishDateOfUse
Type
Date
Description
Name
maxScore
Type
Float
Description
Name
modifiedAt
Type
Date
Description
Name
modifiedBy
Type
String
Description
Name
startDate
Type
Date
Description
Name
status
Type
String
Description
Name
title
Type
String
Description

DonateMain

Fields

Name
list
Type
[Donate]
Description
Name
totalCount
Type
Int
Description

Email

Fields

Name
email
Type
String
Description

EmailDelivery

Fields

Name
_id
Type
String!
Description
Name
attachment
Type
JSON
Description
Name
bcc
Type
[String]
Description
Name
body
Type
String
Description
Name
cc
Type
[String]
Description
Name
createdAt
Type
Date
Description
Name
customerId
Type
String
Description
Name
from
Type
String
Description
Name
fromEmail
Type
String
Description
Name
fromUser
Type
User
Description
Name
kind
Type
String
Description
Name
status
Type
String
Description
Name
subject
Type
String
Description
Name
to
Type
[String]
Description
Name
userId
Type
String
Description

EmailDeliveryList

Fields

Name
list
Type
[EmailDelivery]
Description
Name
totalCount
Type
Int
Description

EmailTemplate

Fields

Name
_id
Type
String!
Description
Name
content
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdUser
Type
User
Description
Name
modifiedAt
Type
Date
Description
Name
name
Type
String!
Description

EngageData

Fields

Name
brandId
Type
String
Description
Name
content
Type
String
Description
Name
fromUser
Type
User
Description
Name
fromUserId
Type
String
Description
Name
kind
Type
String
Description
Name
messageId
Type
String
Description
Name
sentAs
Type
String
Description

EngageDeliveryReport

Fields

Name
list
Type
[DeliveryReport]
Description
Name
totalCount
Type
Int
Description

EngageLog

Fields

Name
_id
Type
String
Description
Name
createdAt
Type
Date
Description
Name
engageMessageId
Type
String
Description
Name
message
Type
String
Description
Name
type
Type
String
Description

EngageMessage

Fields

Name
_id
Type
String!
Description
Name
brand
Type
Brand
Description
Name
brandIds
Type
[String]
Description
Name
brands
Type
[Brand]
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
createdUserName
Type
String
Description
Name
customerIds
Type
[String]
Description
Name
customerTagIds
Type
[String]
Description
Name
customerTags
Type
[Tag]
Description
Name
email
Type
JSON
Description
Name
fromIntegration
Type
JSON
Description
Name
fromUser
Type
User
Description
Name
fromUserId
Type
String
Description
Name
getTags
Type
[Tag]
Description
Name
isDraft
Type
Boolean
Description
Name
isLive
Type
Boolean
Description
Name
kind
Type
String
Description
Name
lastRunAt
Type
Date
Description
Name
logs
Type
[EngageLog]
Description
Name
messenger
Type
JSON
Description
Name
messengerReceivedCustomerIds
Type
[String]
Description
Name
method
Type
String
Description
Name
runCount
Type
Int
Description
Name
scheduleDate
Type
EngageScheduleDate
Description
Name
segmentIds
Type
[String]
Description
Name
segments
Type
[Segment]
Description
Name
shortMessage
Type
EngageMessageSms
Description
Name
smsStats
Type
JSON
Description
Name
stats
Type
JSON
Description
Name
stopDate
Type
Date
Description
Name
tagIds
Type
[String]
Description
Name
title
Type
String
Description
Name
totalCustomersCount
Type
Int
Description
Name
type
Type
String
Description
Name
validCustomersCount
Type
Int
Description

EngageMessageSms

Fields

Name
content
Type
String!
Description
Name
from
Type
String
Description
Name
fromIntegrationId
Type
String
Description

EngageScheduleDate

Fields

Name
dateTime
Type
Date
Description
Name
day
Type
String
Description
Name
month
Type
String
Description
Name
type
Type
String
Description

ENV

Fields

Name
USE_BRAND_RESTRICTIONS
Type
String
Description

Error

Fields

Name
code
Type
String
Description
Name
fieldId
Type
String
Description
Name
text
Type
String
Description

Exm

Fields

Name
_id
Type
String
Description
Name
appearance
Type
ExmAppearance
Description
Name
createdAt
Type
Date
Description
Name
createdBy
Type
String
Description
Name
description
Type
String
Description
Name
features
Type
[ExmFeature]
Description
Name
logo
Type
JSON
Description
Name
name
Type
String
Description
Name
welcomeContent
Type
[ExmWelcomeContent]
Description

ExmAppearance

Fields

Name
primaryColor
Type
String
Description
Name
secondaryColor
Type
String
Description

ExmCeremonyData

Fields

Name
howManyYear
Type
Int
Description
Name
startedDate
Type
Date
Description
Name
willDate
Type
Date
Description
Name
year
Type
Int
Description

ExmEventData

Fields

Name
endDate
Type
Date
Description
Name
goingUserIds
Type
[String]
Description
Name
interestedUserIds
Type
[String]
Description
Name
startDate
Type
Date
Description
Name
visibility
Type
String
Description
Name
where
Type
String
Description

ExmFeature

Fields

Name
_id
Type
String
Description
Name
contentId
Type
String
Description
Name
contentType
Type
String
Description
Name
description
Type
String
Description
Name
icon
Type
String
Description
Name
name
Type
String
Description
Name
subContentId
Type
String
Description

ExmFeed

Fields

Name
_id
Type
String
Description
Name
attachments
Type
JSON
Description
Name
ceremonyData
Type
ExmCeremonyData
Description
Name
commentCount
Type
Int
Description
Name
contentType
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
customFieldsData
Type
JSON
Description
Name
department
Type
String
Description
Name
description
Type
String
Description
Name
endDate
Type
Date
Description
Name
eventData
Type
ExmEventData
Description
Name
eventGoingUsers
Type
[User]
Description
Name
eventInterestedUsers
Type
[User]
Description
Name
heartCount
Type
Int
Description
Name
images
Type
JSON
Description
Name
isHearted
Type
Boolean
Description
Name
isLiked
Type
Boolean
Description
Name
isPinned
Type
Boolean
Description
Name
likeCount
Type
Int
Description
Name
recipientIds
Type
[String]
Description
Name
recipients
Type
[User]
Description
Name
startDate
Type
Date
Description
Name
title
Type
String
Description
Name
updatedAt
Type
Date
Description
Name
updatedUser
Type
User
Description
Name
visibility
Type
String
Description
Name
where
Type
String
Description

ExmFeedResponse

Fields

Name
list
Type
[ExmFeed]
Description
Name
totalCount
Type
Int
Description

ExmList

Fields

Name
list
Type
[Exm]
Description
Name
totalCount
Type
Int
Description

ExmThank

Fields

Name
_id
Type
String
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
description
Type
String
Description
Name
recipientIds
Type
[String]
Description
Name
recipients
Type
[User]
Description
Name
updatedAt
Type
Date
Description

ExmThankResponse

Fields

Name
list
Type
[ExmThank]
Description
Name
totalCount
Type
Int
Description

ExmWelcomeContent

Fields

Name
_id
Type
String
Description
Name
content
Type
String
Description
Name
image
Type
JSON
Description
Name
title
Type
String
Description

ExportHistory

Fields

Name
_id
Type
String!
Description
Name
contentType
Type
String
Description
Name
date
Type
Date
Description
Name
exportLink
Type
String
Description
Name
name
Type
String
Description
Name
status
Type
String
Description
Name
total
Type
String
Description
Name
user
Type
User
Description

ExportHistoryList

Fields

Name
count
Type
Int
Description
Name
list
Type
[ExportHistory]
Description

FacebookComment

Fields

Name
attachments
Type
[String]
Description
Name
commentCount
Type
Int
Description
Name
commentId
Type
String
Description
Name
content
Type
String
Description
Name
conversationId
Type
String
Description
Name
customer
Type
FacebookCustomer
Description
Name
erxesApiId
Type
String
Description
Name
isResolved
Type
Boolean
Description
Name
parentId
Type
String
Description
Name
permalink_url
Type
Int
Description
Name
postId
Type
String
Description
Name
recipientId
Type
String
Description
Name
senderId
Type
String
Description
Name
timestamp
Type
Date
Description

FacebookConversationMessage

Fields

Name
_id
Type
String!
Description
Name
attachments
Type
[Attachment]
Description
Name
botData
Type
JSON
Description
Name
content
Type
String
Description
Name
conversationId
Type
String
Description
Name
createdAt
Type
Date
Description
Name
customer
Type
[Customer]
Description
Name
customerId
Type
String
Description
Name
fromBot
Type
Boolean
Description
Name
internal
Type
Boolean
Description
Name
isCustomerRead
Type
Boolean
Description
Name
mid
Type
String
Description
Name
user
Type
User
Description
Name
userId
Type
String
Description

FacebookCustomer

Fields

Name
_id
Type
String
Description
Name
erxesApiId
Type
String
Description
Name
firstName
Type
String
Description
Name
integrationId
Type
String
Description
Name
lastName
Type
String
Description
Name
profilePic
Type
String
Description
Name
userId
Type
String
Description

FacebookPost

Fields

Name
_id
Type
String!
Description
Name
attachments
Type
String
Description
Name
content
Type
String
Description
Name
erxesApiId
Type
String
Description
Name
permalink_url
Type
String
Description
Name
postId
Type
String
Description
Name
recipientId
Type
String
Description
Name
senderId
Type
String
Description
Name
timestamp
Type
Date
Description

Field

Fields

Name
_id
Type
String!
Description
Name
associatedField
Type
Field
Description
Name
associatedFieldId
Type
String
Description
Name
canHide
Type
Boolean
Description
Name
code
Type
String
Description
Name
column
Type
Int
Description
Name
content
Type
String
Description
Name
contentType
Type
String!
Description
Name
contentTypeId
Type
String
Description
Name
description
Type
String
Description
Name
field
Type
String
Description
Name
groupId
Type
String
Description
Name
groupName
Type
String
Description
Name
isDefinedByErxes
Type
Boolean
Description
Name
isRequired
Type
Boolean
Description
Name
isVisible
Type
Boolean
Description
Name
isVisibleInDetail
Type
Boolean
Description
Name
isVisibleToCreate
Type
Boolean
Description
Name
lastUpdatedUser
Type
User
Description
Name
lastUpdatedUserId
Type
String
Description
Name
locationOptions
Type
[LocationOption]
Description
Name
logicAction
Type
String
Description
Name
logics
Type
[Logic]
Description
Name
name
Type
String
Description
Name
objectListConfigs
Type
[ObjectListConfig]
Description
Name
options
Type
[String]
Description
Name
optionsValues
Type
String
Description
Name
order
Type
Int
Description
Name
pageNumber
Type
Int
Description
Name
productCategoryId
Type
String
Description
Name
products
Type
[Product]
Description
Name
searchable
Type
Boolean
Description
Name
showInCard
Type
Boolean
Description
Name
text
Type
String
Description
Name
type
Type
String
Description
Name
validation
Type
String
Description

FieldsGroup

Fields

Name
_id
Type
String!
Description
Name
code
Type
String
Description
Name
config
Type
JSON
Description
Name
contentType
Type
String
Description
Name
description
Type
String
Description
Name
fields
Type
[Field]
Description
Name
isDefinedByErxes
Type
Boolean
Description
Name
isMultiple
Type
Boolean
Description
Name
isVisible
Type
Boolean
Description
Name
isVisibleInDetail
Type
Boolean
Description
Name
lastUpdatedUser
Type
User
Description
Name
lastUpdatedUserId
Type
String
Description
Name
logicAction
Type
String
Description
Name
logics
Type
[Logic]
Description
Name
name
Type
String
Description
Name
order
Type
Int
Description
Name
parentId
Type
String
Description

Form

Fields

Name
_id
Type
String!
Description
Name
buttonText
Type
String
Description
Name
code
Type
String
Description
Name
createdDate
Type
Date
Description
Name
createdUser
Type
User
Description
Name
createdUserId
Type
String
Description
Name
description
Type
String
Description
Name
fields
Type
[Field]
Description
Name
googleMapApiKey
Type
String
Description
Name
numberOfPages
Type
Int
Description
Name
title
Type
String
Description
Name
type
Type
String
Description

FormCode

Fields

Name
brandId
Type
String
Description
Name
formId
Type
String
Description

FormConnectResponse

Fields

Name
form
Type
Form
Description
Name
integration
Type
Integration
Description

FormSubmission

Fields

Name
_id
Type
String!
Description
Name
customerId
Type
String
Description
Name
formFieldId
Type
String
Description
Name
formFieldText
Type
String
Description
Name
formId
Type
String
Description
Name
submittedAt
Type
Date
Description
Name
text
Type
String
Description
Name
value
Type
JSON
Description

GrowthHack

Fields

Name
_id
Type
String!
Description
Name
assignedUserIds
Type
[String]
Description
Name
assignedUsers
Type
[User]
Description
Name
attachments
Type
[Attachment]
Description
Name
boardId
Type
String
Description
Name
branchIds
Type
[String]
Description
Name
closeDate
Type
Date
Description
Name
confidence
Type
Int
Description
Name
createdAt
Type
Date
Description
Name
createdUser
Type
User
Description
Name
customFieldsData
Type
JSON
Description
Name
customProperties
Type
JSON
Description
Name
departmentIds
Type
[String]
Description
Name
description
Type
String
Description
Name
ease
Type
Int
Description
Name
formFields
Type
[Field]
Description
Name
formId
Type
String
Description
Name
formSubmissions
Type
JSON
Description
Name
hackStages
Type
[String]
Description
Name
hasNotified
Type
Boolean
Description
Name
impact
Type
Int
Description
Name
isComplete
Type
Boolean
Description
Name
isVoted
Type
Boolean
Description
Name
isWatched
Type
Boolean
Description
Name
labelIds
Type
[String]
Description
Name
labels
Type
[PipelineLabel]
Description
Name
modifiedAt
Type
Date
Description
Name
modifiedBy
Type
String!
Description
Name
name
Type
String
Description
Name
number
Type
String
Description
Name
order
Type
Float
Description
Name
pipeline
Type
Pipeline
Description
Name
priority
Type
String
Description
Name
reach
Type
Int
Description
Name
reminderMinute
Type
Int
Description
Name
score
Type
Float
Description
Name
scoringType
Type
String
Description
Name
stage
Type
Stage
Description
Name
stageChangedDate
Type
Date
Description
Name
stageId
Type
String
Description
Name
startDate
Type
Date
Description
Name
status
Type
String
Description
Name
tagIds
Type
[String]
Description
Name
timeTrack
Type
TimeTrack
Description
Name
userId
Type
String
Description
Name
voteCount
Type
Int
Description
Name
votedUsers
Type
[User]
Description

IMap

Fields

Name
_id
Type
String!
Description
Name
mailData
Type
JSON
Description
Name
title
Type
String
Description

IMapIntegration

Fields

Name
host
Type
String
Description
Name
inboxId
Type
String
Description
Name
mainUser
Type
String
Description
Name
password
Type
String
Description
Name
smtpHost
Type
String
Description
Name
smtpPort
Type
String
Description
Name
user
Type
String
Description

ImportHistory

Fields

Name
_id
Type
String!
Description
Name
attachments
Type
JSON
Description
Name
contentTypes
Type
JSON
Description
Name
date
Type
Date
Description
Name
error
Type
String
Description
Name
errorMsgs
Type
[String]
Description
Name
failed
Type
String
Description
Name
ids
Type
[String]
Description
Name
name
Type
String
Description
Name
percentage
Type
Float
Description
Name
removed
Type
[String]
Description
Name
status
Type
String
Description
Name
success
Type
String!
Description
Name
total
Type
String
Description
Name
updated
Type
String
Description
Name
user
Type
User
Description