## CompaniesListResponse

**Type:** GraphQL objects

**Description:**
Paginated company list response.

### Fields
- data (Company): undefined
  - createdAt (Date)
  - modifiedAt (Date)
  - avatar (String)
  - size (Int)
  - website (String)
  - industry (String)
  - plan (String)
  - parentCompanyId (String)
  - ownerId (String)
  - mergedIds (String)
  - names (String)
  - primaryName (String)
  - emails (String)
  - primaryEmail (String)
  - phones (String)
  - primaryPhone (String)
  - primaryAddress (JSON)
  - addresses (JSON)
  - businessType (String)
  - description (String)
  - isSubscribed (String)
  - links (JSON)
  - owner (User)
  - parentCompany (Company)
  - tagIds (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - customers (Customer)
  - getTags (Tag)
  - code (String)
  - location (String)
  - score (Float)
  - _id (String)
- pagination (PaginationInfo, Not Null): undefined
  - currentPage (Int): The current page number (1-based).
  - perPage (Int): Number of items per page.
  - totalCount (Int): Total number of items matching the query.
  - totalPages (Int): Total number of pages.
  - hasNextPage (Boolean): Whether there are more pages after the current one.
  - hasPreviousPage (Boolean): Whether there are pages before the current one.

---

## Company

**Type:** GraphQL objects

**Description:**
Company (account) entity that aggregates contacts, contact details, and CRM metadata.

### Fields
- createdAt (Date)
- modifiedAt (Date)
- avatar (String)
- size (Int)
- website (String)
- industry (String)
- plan (String)
- parentCompanyId (String)
- ownerId (String)
- mergedIds (String)
- names (String)
- primaryName (String)
- emails (String)
- primaryEmail (String)
- phones (String)
- primaryPhone (String)
- primaryAddress (JSON)
- addresses (JSON)
- businessType (String)
- description (String)
- isSubscribed (String)
- links (JSON)
- owner (User): undefined
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)
- parentCompany (Company): undefined
  - createdAt (Date)
  - modifiedAt (Date)
  - avatar (String)
  - size (Int)
  - website (String)
  - industry (String)
  - plan (String)
  - parentCompanyId (String)
  - ownerId (String)
  - mergedIds (String)
  - names (String)
  - primaryName (String)
  - emails (String)
  - primaryEmail (String)
  - phones (String)
  - primaryPhone (String)
  - primaryAddress (JSON)
  - addresses (JSON)
  - businessType (String)
  - description (String)
  - isSubscribed (String)
  - links (JSON)
  - owner (User)
  - parentCompany (Company)
  - tagIds (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - customers (Customer)
  - getTags (Tag)
  - code (String)
  - location (String)
  - score (Float)
  - _id (String)
- tagIds (String)
- customFieldsData (JSON)
- customFieldsDataByFieldCode (JSON)
- customers (Customer): undefined
  - state (String)
  - createdAt (Date)
  - modifiedAt (Date)
  - avatar (String)
  - integrationId (String)
  - firstName (String)
  - lastName (String)
  - birthDate (Date)
  - sex (Int)
  - email (String)
  - primaryEmail (String)
  - emails (String)
  - primaryPhone (String)
  - phones (String)
  - primaryAddress (JSON)
  - addresses (JSON)
  - phone (String)
  - tagIds (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - ownerId (String)
  - leadStatus (String)
  - leadStageHistory (LeadStageHistoryEntry)
  - description (String)
  - isSubscribed (String)
  - code (String)
  - emailValidationStatus (String)
  - phoneValidationStatus (String)
  - links (JSON)
  - companies (Company)
  - getTags (Tag)
  - integration (Integration)
  - owner (User)
  - score (Float)
  - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only).
  - _id (String)
  - conversations (Conversation)
- getTags (Tag): undefined
  - _id (String)
  - name (String)
  - type (String)
  - colorCode (String)
  - createdAt (Date)
  - objectCount (Int)
  - totalObjectCount (Int)
  - parentId (String)
  - order (String)
  - relatedIds (String)
  - childTags (Tag)
- code (String)
- location (String)
- score (Float)
- _id (String)

---

## Conformity

**Type:** GraphQL objects

### Fields
- _id (String)
- mainType (String)
- mainTypeId (String)
- relType (String)
- relTypeId (String)

---

## Customer

**Type:** GraphQL objects

**Description:**
Customer/contact entity capturing personal details, subscription status, and engagement metadata.

### Fields
- state (String)
- createdAt (Date)
- modifiedAt (Date)
- avatar (String)
- integrationId (String)
- firstName (String)
- lastName (String)
- birthDate (Date)
- sex (Int)
- email (String)
- primaryEmail (String)
- emails (String)
- primaryPhone (String)
- phones (String)
- primaryAddress (JSON)
- addresses (JSON)
- phone (String)
- tagIds (String)
- customFieldsData (JSON)
- customFieldsDataByFieldCode (JSON)
- ownerId (String)
- leadStatus (String)
- leadStageHistory (LeadStageHistoryEntry): undefined
  - stageCode (String)
  - at (Date)
  - byUserId (String)
  - note (String)
- description (String)
- isSubscribed (String)
- code (String)
- emailValidationStatus (String)
- phoneValidationStatus (String)
- links (JSON)
- companies (Company): undefined
  - createdAt (Date)
  - modifiedAt (Date)
  - avatar (String)
  - size (Int)
  - website (String)
  - industry (String)
  - plan (String)
  - parentCompanyId (String)
  - ownerId (String)
  - mergedIds (String)
  - names (String)
  - primaryName (String)
  - emails (String)
  - primaryEmail (String)
  - phones (String)
  - primaryPhone (String)
  - primaryAddress (JSON)
  - addresses (JSON)
  - businessType (String)
  - description (String)
  - isSubscribed (String)
  - links (JSON)
  - owner (User)
  - parentCompany (Company)
  - tagIds (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - customers (Customer)
  - getTags (Tag)
  - code (String)
  - location (String)
  - score (Float)
  - _id (String)
- getTags (Tag): undefined
  - _id (String)
  - name (String)
  - type (String)
  - colorCode (String)
  - createdAt (Date)
  - objectCount (Int)
  - totalObjectCount (Int)
  - parentId (String)
  - order (String)
  - relatedIds (String)
  - childTags (Tag)
- integration (Integration): undefined
  - _id (String)
  - kind (String)
  - name (String)
  - languageCode (String)
  - code (String)
  - formId (String)
  - tagIds (String)
  - createdAt (Date)
  - workspaceId (String)
  - tags (Tag)
  - leadData (JSON)
  - messengerData (JSON)
  - whatsappData (WhatsappIntegration)
  - uiOptions (JSON)
  - isActive (Boolean)
  - isConnected (Boolean)
  - webhookData (JSON)
  - form (Form)
  - departmentId (String)
  - department (Department)
  - workspace (Workspace)
  - websiteMessengerApps (MessengerApp)
  - knowledgeBaseMessengerApps (MessengerApp)
  - leadMessengerApps (MessengerApp)
  - healthStatus (JSON)
  - visibility (String)
  - departmentIds (String)
  - details (JSON)
- owner (User): undefined
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)
- score (Float)
- segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only).
  - segmentId (String)
  - name (String)
  - status (String)
  - enteredAt (Date)
  - source (String)
- _id (String)
- conversations (Conversation): undefined
  - _id (String)
  - content (String): The latest text content or snippet of the conversation.
  - integrationId (String): The integration (channel) this conversation originated from.
  - customerId (String): The customer participating in this conversation.
  - departmentId (String): The department this conversation is routed to.
  - userId (String): The user/agent who created or owns this conversation.
  - assignedUserId (String): The user/agent currently assigned to handle this conversation.
  - participatedUserIds (String): User IDs of agents participating in this conversation.
  - readUserIds (String): User IDs of agents who have read this conversation.
  - createdAt (Date): When this conversation was created.
  - updatedAt (Date): When this conversation was last updated.
  - slaTime (Float): SLA elapsed idle time in minutes (time since customer started waiting for a response).
  - slaConfig (Float): Configured SLA threshold in minutes.
  - idleTime (Float): Idle time in minutes (deprecated — use slaTime).
  - idleTimeConfig (Float): Configured idle time threshold in minutes (deprecated — use slaConfig).
  - isCustomerRespondedLast (Boolean): Whether the customer sent the most recent message.
  - lastCustomerMessageAt (Date): Timestamp of the last customer message.
  - lastUserMessageAt (Date): Timestamp of the last agent message.
  - customerWaitingStartTime (Date): When the customer started waiting for a response.
  - averageResponseTime (Float): Average agent response time in seconds.
  - totalResponseTime (Float): Total cumulative response time in seconds.
  - responseCount (Int): Number of agent responses in this conversation.
  - status (String): Current workflow status: 'open', 'closed', 'pending', 'snoozed', or 'bot'.
  - snoozedUntil (Date): When a snoozed conversation will auto-reopen (null if indefinite or not snoozed).
  - messageCount (Int): Total number of messages in this conversation.
  - number (Int): Auto-incremented conversation number for display.
  - tagIds (String): Tag IDs applied to this conversation.
  - messages (ConversationMessage): The most recent message in this conversation, resolved from the appropriate service (inbox, whatsapp, facebook, etc.).
  - tags (Tag): Resolved tags applied to this conversation.
  - customer (Customer): The customer associated with this conversation.
  - integration (Integration): The integration (channel) this conversation came from.
  - user (User): The user/agent who owns this conversation.
  - assignedUser (User): The agent currently assigned to this conversation.
  - assignedDepartment (Department): The department this conversation is routed to.
  - participatedUsers (User): Users participating in this conversation.
  - readUsers (User): Users who have read this conversation.
  - participatorCount (Int): Number of participants in this conversation.
  - customFieldsData (JSON)

---

## CustomerSegmentV2Membership

**Type:** GraphQL objects

**Description:**
A customer's membership in a segments-v2 segment (active version).

### Fields
- segmentId (String)
- name (String)
- status (String)
- enteredAt (Date)
- source (String)

---

## CustomersListResponse

**Type:** GraphQL objects

**Description:**
Paginated customers response.

### Fields
- data (Customer): undefined
  - state (String)
  - createdAt (Date)
  - modifiedAt (Date)
  - avatar (String)
  - integrationId (String)
  - firstName (String)
  - lastName (String)
  - birthDate (Date)
  - sex (Int)
  - email (String)
  - primaryEmail (String)
  - emails (String)
  - primaryPhone (String)
  - phones (String)
  - primaryAddress (JSON)
  - addresses (JSON)
  - phone (String)
  - tagIds (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - ownerId (String)
  - leadStatus (String)
  - leadStageHistory (LeadStageHistoryEntry)
  - description (String)
  - isSubscribed (String)
  - code (String)
  - emailValidationStatus (String)
  - phoneValidationStatus (String)
  - links (JSON)
  - companies (Company)
  - getTags (Tag)
  - integration (Integration)
  - owner (User)
  - score (Float)
  - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only).
  - _id (String)
  - conversations (Conversation)
- pagination (PaginationInfo, Not Null): undefined
  - currentPage (Int): The current page number (1-based).
  - perPage (Int): Number of items per page.
  - totalCount (Int): Total number of items matching the query.
  - totalPages (Int): Total number of pages.
  - hasNextPage (Boolean): Whether there are more pages after the current one.
  - hasPreviousPage (Boolean): Whether there are pages before the current one.

---

## Field

**Type:** GraphQL objects

### Fields
- _id (String)
- contentType (String)
- contentTypeId (String)
- name (String)
- isVisible (Boolean)
- isVisibleInDetail (Boolean)
- canHide (Boolean)
- groupId (String)
- lastUpdatedUser (User): undefined
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)
- lastUpdatedUserId (String)
- associatedField (Field): undefined
  - _id (String)
  - contentType (String)
  - contentTypeId (String)
  - name (String)
  - isVisible (Boolean)
  - isVisibleInDetail (Boolean)
  - canHide (Boolean)
  - groupId (String)
  - lastUpdatedUser (User)
  - lastUpdatedUserId (String)
  - associatedField (Field)
  - locationOptions (LocationOption)
  - objectListConfigs (ObjectListConfig)
  - optionsValues (String)
  - subFieldIds (String)
  - subFields (Field)
  - products (Product)
  - logics (Logic)
  - description (String)
  - options (String)
  - type (String)
  - validation (String)
  - regexValidation (String)
  - text (String)
  - content (String)
  - isRequired (Boolean)
  - order (Int)
  - associatedFieldId (String)
  - logicAction (String)
  - column (Int)
  - pageNumber (Int)
  - code (String)
  - searchable (Boolean)
  - showInCard (Boolean)
  - isVisibleToCreate (Boolean)
  - productCategoryId (String)
  - field (String)
  - isDefinedByKarzoun (Boolean)
- locationOptions (LocationOption): undefined
  - lat (Float)
  - lng (Float)
  - description (String)
- objectListConfigs (ObjectListConfig): undefined
  - key (String)
  - label (String)
  - type (String)
- optionsValues (String)
- subFieldIds (String)
- subFields (Field): undefined
  - _id (String)
  - contentType (String)
  - contentTypeId (String)
  - name (String)
  - isVisible (Boolean)
  - isVisibleInDetail (Boolean)
  - canHide (Boolean)
  - groupId (String)
  - lastUpdatedUser (User)
  - lastUpdatedUserId (String)
  - associatedField (Field)
  - locationOptions (LocationOption)
  - objectListConfigs (ObjectListConfig)
  - optionsValues (String)
  - subFieldIds (String)
  - subFields (Field)
  - products (Product)
  - logics (Logic)
  - description (String)
  - options (String)
  - type (String)
  - validation (String)
  - regexValidation (String)
  - text (String)
  - content (String)
  - isRequired (Boolean)
  - order (Int)
  - associatedFieldId (String)
  - logicAction (String)
  - column (Int)
  - pageNumber (Int)
  - code (String)
  - searchable (Boolean)
  - showInCard (Boolean)
  - isVisibleToCreate (Boolean)
  - productCategoryId (String)
  - field (String)
  - isDefinedByKarzoun (Boolean)
- products (Product): undefined
  - _id (String)
  - name (String)
  - shortName (String)
  - slug (String)
  - status (String)
  - code (String)
  - type (String)
  - description (String)
  - barcodes (String)
  - unitPrice (Float)
  - salePrice (Float)
  - costPrice (Float)
  - currency (String)
  - categoryId (String)
  - customFieldsData (JSON)
  - customFieldsDataByFieldCode (JSON)
  - createdAt (Date)
  - updatedAt (Date)
  - publishedAt (Date)
  - createdBy (String)
  - updatedBy (String)
  - getTags (Tag)
  - tagIds (String)
  - attachment (Attachment)
  - attachmentMore (Attachment)
  - media (Attachment)
  - vendorId (String)
  - workspaceId (String)
  - uom (String)
  - subUoms (JSON)
  - category (ProductCategory)
  - vendor (Company)
  - taxType (String)
  - taxCode (String)
  - sku (String)
  - externalUrl (String)
  - source (String)
  - mpn (String)
  - gtin (String)
  - requireShipping (Boolean)
  - channels (String)
  - unlimitedQuantity (Boolean)
  - saleStart (Date)
  - saleEnd (Date)
  - maxPerOrder (Int)
  - maxPerCustomer (Int)
  - isAvailable (Boolean)
  - hideQuantity (Boolean)
  - productOptions (ProductOption)
  - productVariants (ProductVariant)
  - priceRange (PriceRange)
  - hasVariants (Boolean)
  - hasCatalogWarning (Boolean)
  - weight (Float)
  - weightUnit (String)
  - dimensions (ProductDimensions)
  - inventory (ProductInventory)
  - seo (ProductSEO)
- logics (Logic): undefined
  - fieldId (String)
  - logicOperator (String)
  - logicValue (JSON)
- description (String)
- options (String)
- type (String)
- validation (String)
- regexValidation (String)
- text (String)
- content (String)
- isRequired (Boolean)
- order (Int)
- associatedFieldId (String)
- logicAction (String)
- column (Int)
- pageNumber (Int)
- code (String)
- searchable (Boolean)
- showInCard (Boolean)
- isVisibleToCreate (Boolean)
- productCategoryId (String)
- field (String)
- isDefinedByKarzoun (Boolean)

---

## FieldsGroup

**Type:** GraphQL objects

### Fields
- _id (String)
- name (String)
- contentType (String)
- order (Int)
- code (String)
- parentId (String)
- description (String)
- isMultiple (Boolean)
- isVisible (Boolean)
- isVisibleInDetail (Boolean)
- alwaysOpen (Boolean)
- isDefinedByKarzoun (Boolean)
- fields (Field): undefined
  - _id (String)
  - contentType (String)
  - contentTypeId (String)
  - name (String)
  - isVisible (Boolean)
  - isVisibleInDetail (Boolean)
  - canHide (Boolean)
  - groupId (String)
  - lastUpdatedUser (User)
  - lastUpdatedUserId (String)
  - associatedField (Field)
  - locationOptions (LocationOption)
  - objectListConfigs (ObjectListConfig)
  - optionsValues (String)
  - subFieldIds (String)
  - subFields (Field)
  - products (Product)
  - logics (Logic)
  - description (String)
  - options (String)
  - type (String)
  - validation (String)
  - regexValidation (String)
  - text (String)
  - content (String)
  - isRequired (Boolean)
  - order (Int)
  - associatedFieldId (String)
  - logicAction (String)
  - column (Int)
  - pageNumber (Int)
  - code (String)
  - searchable (Boolean)
  - showInCard (Boolean)
  - isVisibleToCreate (Boolean)
  - productCategoryId (String)
  - field (String)
  - isDefinedByKarzoun (Boolean)
- lastUpdatedUserId (String)
- lastUpdatedUser (User): undefined
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)
- config (JSON)
- logicAction (String)
- logics (Logic): undefined
  - fieldId (String)
  - logicOperator (String)
  - logicValue (JSON)

---

## Form

**Type:** GraphQL objects

### Fields
- _id (String)
- name (String)
- title (String)
- code (String)
- type (String)
- description (String)
- buttonText (String)
- createdUserId (String)
- createdUser (User): undefined
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)
- createdDate (Date)
- numberOfPages (Int)
- status (String)
- googleMapApiKey (String)
- fields (Field): undefined
  - _id (String)
  - contentType (String)
  - contentTypeId (String)
  - name (String)
  - isVisible (Boolean)
  - isVisibleInDetail (Boolean)
  - canHide (Boolean)
  - groupId (String)
  - lastUpdatedUser (User)
  - lastUpdatedUserId (String)
  - associatedField (Field)
  - locationOptions (LocationOption)
  - objectListConfigs (ObjectListConfig)
  - optionsValues (String)
  - subFieldIds (String)
  - subFields (Field)
  - products (Product)
  - logics (Logic)
  - description (String)
  - options (String)
  - type (String)
  - validation (String)
  - regexValidation (String)
  - text (String)
  - content (String)
  - isRequired (Boolean)
  - order (Int)
  - associatedFieldId (String)
  - logicAction (String)
  - column (Int)
  - pageNumber (Int)
  - code (String)
  - searchable (Boolean)
  - showInCard (Boolean)
  - isVisibleToCreate (Boolean)
  - productCategoryId (String)
  - field (String)
  - isDefinedByKarzoun (Boolean)
- visibility (String)
- leadData (JSON)
- languageCode (String)
- departmentIds (String)
- tagIds (String)
- tags (Tag): undefined
  - _id (String)
  - name (String)
  - type (String)
  - colorCode (String)
  - createdAt (Date)
  - objectCount (Int)
  - totalObjectCount (Int)
  - parentId (String)
  - order (String)
  - relatedIds (String)
  - childTags (Tag)
- workspaceId (String)
- workspace (Workspace): undefined
  - _id (String)
  - name (String)
  - description (String)
  - code (String)
  - userId (String)
  - createdAt (Date)
  - memberIds (String)
- integrationId (String)

---

## FormCode

**Type:** GraphQL objects

**Description:**
A form code linking a brand to a form within a knowledge base article.

### Fields
- workspaceId (String)
- formId (String)

---

## FormsResponse

**Type:** GraphQL objects

### Fields
- data (Form): undefined
  - _id (String)
  - name (String)
  - title (String)
  - code (String)
  - type (String)
  - description (String)
  - buttonText (String)
  - createdUserId (String)
  - createdUser (User)
  - createdDate (Date)
  - numberOfPages (Int)
  - status (String)
  - googleMapApiKey (String)
  - fields (Field)
  - visibility (String)
  - leadData (JSON)
  - languageCode (String)
  - departmentIds (String)
  - tagIds (String)
  - tags (Tag)
  - workspaceId (String)
  - workspace (Workspace)
  - integrationId (String)
- pagination (PaginationInfo, Not Null): undefined
  - currentPage (Int): The current page number (1-based).
  - perPage (Int): Number of items per page.
  - totalCount (Int): Total number of items matching the query.
  - totalPages (Int): Total number of pages.
  - hasNextPage (Boolean): Whether there are more pages after the current one.
  - hasPreviousPage (Boolean): Whether there are pages before the current one.

---

## FormsTotalCount

**Type:** GraphQL objects

### Fields
- total (Int)
- byTag (JSON)
- byWorkspace (JSON)
- byStatus (JSON)

---

## FormSubmission

**Type:** GraphQL objects

### Fields
- _id (String)
- customerId (String)
- formId (String)
- formFieldId (String)
- text (String)
- formFieldText (String)
- value (JSON)
- submittedAt (Date)

---

## FormSubmissionListResponse

**Type:** GraphQL objects

### Fields
- data (Submission): undefined
  - _id (String)
  - contentTypeId (String)
  - customerId (String)
  - customer (Customer)
  - createdAt (Date)
  - customFieldsData (JSON)
  - submissions (FormSubmission)
- pagination (PaginationInfo, Not Null): undefined
  - currentPage (Int): The current page number (1-based).
  - perPage (Int): Number of items per page.
  - totalCount (Int): Total number of items matching the query.
  - totalPages (Int): Total number of pages.
  - hasNextPage (Boolean): Whether there are more pages after the current one.
  - hasPreviousPage (Boolean): Whether there are pages before the current one.

---

## Tag

**Type:** GraphQL objects

**Description:**
Tag used for categorizing entities across the system.

### Fields
- _id (String)
- name (String)
- type (String)
- colorCode (String)
- createdAt (Date)
- objectCount (Int)
- totalObjectCount (Int)
- parentId (String)
- order (String)
- relatedIds (String)
- childTags (Tag): undefined
  - _id (String)
  - name (String)
  - type (String)
  - colorCode (String)
  - createdAt (Date)
  - objectCount (Int)
  - totalObjectCount (Int)
  - parentId (String)
  - order (String)
  - relatedIds (String)
  - childTags (Tag)

---

## TaggedPayload

**Type:** GraphQL objects

**Description:**
Payload for tagged action.

### Fields
- tagName (String)

---

## TagsChangedPayload

**Type:** GraphQL objects

**Description:**
Payload for tags_changed action.

### Fields
- addedTagIds (String)
- removedTagIds (String)
- performedBy (String)
- viaAutomation (Boolean)
- performedByUser (User): Resolved user who performed the tags change.
  - _id (String)
  - createdAt (Date)
  - username (String)
  - email (String)
  - userPreferences (JSON)
  - availability (UserChatStatus)
  - isActive (Boolean)
  - details (UserDetailsType)
  - links (JSON)
  - status (String)
  - emailSignatures (JSON)
  - groupIds (String)
  - workspaceIds (String)
  - isSubscribed (String)
  - customFieldsData (JSON)
  - workspaces (Workspace)
  - isOwner (Boolean)
  - permissionActions (JSON)
  - configs (JSON)
  - configsConstants (JSON)
  - onboardingHistory (OnboardingHistory)
  - departmentIds (String)
  - departments (Department)
  - branchIds (String)
  - branches (Branch)
  - positionIds (String)
  - positions (Position)
  - score (Float)
  - scoreCategories (ScoreCategories)
  - leaderBoardPosition (Int)
  - employeeId (String)
  - isOnline (Boolean)

---

## TagsPaginatedResponse

**Type:** GraphQL objects

### Fields
- data (Tag, Not Null): undefined
  - _id (String)
  - name (String)
  - type (String)
  - colorCode (String)
  - createdAt (Date)
  - objectCount (Int)
  - totalObjectCount (Int)
  - parentId (String)
  - order (String)
  - relatedIds (String)
  - childTags (Tag)
- pagination (PaginationInfo, Not Null): undefined
  - currentPage (Int): The current page number (1-based).
  - perPage (Int): Number of items per page.
  - totalCount (Int): Total number of items matching the query.
  - totalPages (Int): Total number of pages.
  - hasNextPage (Boolean): Whether there are more pages after the current one.
  - hasPreviousPage (Boolean): Whether there are pages before the current one.