## Queries
- users: Paginated users list with filters for workspaces, departments, branches, status, and availability.
Returns { list, totalCount } in a single response using paginateQuery.
- userDetail: Load a single user with extended details by identifier.
- currentUser: Resolve the profile of the currently authenticated user.
- departments: Paginated departments with optional status/parent filters, returns list + counts.
- departmentDetail: undefined
- branches: Paginated branches with optional status/parent filters, returns list + counts.
- branchDetail: undefined
- apps: Paginated apps list with optional search filter.
Returns { data, pagination } using paginateQuery.
- appDetail: Fetch a single app credential by id.
- tags: Paginated tags with search and hierarchical filters.
- tagDetail: Fetch tag details by id.
- tagsQueryCount: Count tags for a given type/search.
- formDetail: undefined
- forms: undefined
- formsTotalCount: undefined
- formSubmissions: undefined
- formSubmissionsTotalCount: undefined
- formSubmissionDetail: undefined
- fieldsGetTypes: undefined
- fieldsCombinedByContentType: undefined
- fieldsDefaultColumnsConfig: undefined
- fieldsGroups: undefined
- fieldsGetDetail: undefined
- companies: Fetch paginated companies with filters, segmentation, and conformity context; returns paginated list.
- companyCounts: Return counts for companies matching the supplied filters (optionally scoped by "only").
- companyDetail: Load detailed company data by id including contacts, owners, and tags.
- customers: Fetch paginated customers with filtering, segmentation, and conformity context; returns paginated list.
- customerCounts: Return aggregated counts for customers matching filters (optionally scoped by "only" or source).
- customerDetail: Load a customer by id with full profile, ownership, tags, and integration info.
- productCategories: List product categories with optional workspace filter and tree traversal.
- productCategoryDetail: Fetch single product category detail by id.
- products: List products with filtering, segmentation, and pagination.
- productDetail: Detailed product by id.
- productCountByTags: Count products grouped by tag.
- conversationMessage: Retrieves a single conversation message by its ID.
Use this to get full details of a specific message.
- conversations: Searches and retrieves a paginated list of conversations based on filters.
Use this to find conversations by status, assignment, date range, or other criteria.
Returns conversations sorted by the specified field or by last activity.
- conversationMessages: Retrieves a paginated list of messages within a specific conversation.
Returns messages in reverse chronological order by default.
- conversationCounts: Returns aggregated counts of conversations grouped by various criteria.
Useful for dashboard statistics and inbox counters.
- conversationDetail: Retrieves complete details of a specific conversation by ID.
Includes customer info, assigned agent, tags, and metadata.
- conversationsTotalUnreadCount: Returns the total count of unread conversations for the current user.
Used for notification badges and alerts.
- inboxFields: Retrieves available custom fields for inbox entities.
Returns field definitions for customers, conversations, and devices.
- knowledgeBaseTopics: undefined
- knowledgeBaseTopicDetail: undefined
- knowledgeBaseTopicsTotalCount: Return the total number of knowledge base topics.
- knowledgeBaseCategories: List knowledge base categories with pagination. Filter by topic, code, or icon.
- knowledgeBaseCategoryDetail: Retrieve a single knowledge base category by ID.
- knowledgeBaseCategoriesTotalCount: Return the total number of categories matching the given filters.
- knowledgeBaseCategoriesGetLast: Return the most recently created knowledge base category.
- knowledgeBaseArticles: List knowledge base articles with pagination, search, sorting, and filtering.
- knowledgeBaseArticleDetail: Retrieve a single knowledge base article by ID.
- knowledgeBaseArticlesTotalCount: Return the total number of articles matching the given filters.
- knowledgeBaseSearch: Perform a semantic search across knowledge base articles using vector similarity.
## Mutations
- conformityAdd: undefined
- conformityEdit: undefined
- appsAdd: Create a new app credential scoped to a user group with optional expiry.
Returns the access token once — it will never be queryable again.
- appsEdit: Update app name and expiration only.
Permissions (userGroupId, allowAllPermission) are locked after creation.
- appsRemove: Remove an app credential by id.
- tagsAdd: Create a new tag.
- tagsEdit: Edit a tag by id.
- tagsRemove: Remove a tag by id.
- tagsTag: Attach/detach tags to target entities.
- tagsMerge: Merge two tags (source into destination).
- formSubmissionsSave: undefined
- fieldsAdd: undefined
- fieldsEdit: undefined
- fieldsRemove: undefined
- fieldsGroupsAdd: undefined
- fieldsGroupsEdit: undefined
- fieldsGroupsRemove: undefined
- companiesAdd: Create a new company record with core contact, address, and classification fields.
- companiesEdit: Update an existing company by id; supports partial edits of contact and CRM fields.
- companiesEditByField: Patch company fields by selector for bulk or conditional updates.
- companiesRemove: Remove one or more companies; returns removed ids.
- companiesMerge: Merge multiple companies into a primary record, applying provided field overrides.
- customersAdd: Create a new customer/contact. The optional state can denote lead vs. customer pipelines.
- customersEdit: Update a customer by id with profile or CRM attributes.
- customersEditByField: Patch customer fields by selector for conditional/bulk edits.
- customersMerge: Merge several customers into one, applying provided override fields.
- customersRemove: Remove one or more customers; returns removed ids.
- customersChangeState: Change the lifecycle state for a customer (e.g., lead → customer); value expects a known state key.
- productsAdd: Create a new product with pricing, taxonomy, and media.
- productsEdit: Update an existing product by id.
- productsRemove: Remove products by ids; returns status string.
- productCategoriesAdd: Create a product category.
- productCategoriesEdit: Edit a product category by id.
- productCategoriesRemove: Remove a product category by id.
- conversationMessageAdd: Adds a new message to a conversation.
Use this to send replies, internal notes, or bot messages.
Set visibility='internal' for team-only notes invisible to customers.
- conversationMessageUpdate: Updates an existing conversation message.
Can add reactions or change visibility.
- conversationsAssign: Assigns one or more conversations to a user or department.
Use this to route conversations to the appropriate agent or team.
- conversationsUnassign: Removes assignment from conversations, making them unassigned.
Conversations return to the general inbox queue.
- conversationsChangeStatus: Changes the status of one or more conversations.
Use 'closed' to resolve conversations, 'open' to reopen them.
When setting status to 'snoozed', optionally provide snoozedUntil to auto-reopen at that time.
- conversationMarkAsRead: Marks a conversation as read by the current user.
Clears unread indicators and updates read receipts.
- conversationResolveAll: Resolves (closes) all conversations matching the filter criteria.
Use with caution as this performs a bulk status change.
Returns the count of conversations resolved.
- conversationConvertToCard: Converts a conversation into a card (deal, ticket, task, or purchase).
Creates a new card in the specified pipeline stage with conversation context.
Use this to escalate customer issues or create follow-up tasks.
- conversationEditCustomFields: Updates custom field values on a conversation.
Use this to add or modify custom metadata on conversations.
- knowledgeBaseTopicsAdd: Create a new knowledge base topic.
- knowledgeBaseTopicsEdit: Update an existing knowledge base topic.
- knowledgeBaseTopicsRemove: Delete a knowledge base topic and disassociate its categories.
- knowledgeBaseCategoriesAdd: Create a new knowledge base category.
- knowledgeBaseCategoriesEdit: Update an existing knowledge base category.
- knowledgeBaseCategoriesRemove: Delete a knowledge base category and unlink its articles.
- knowledgeBaseArticlesAdd: Create a new knowledge base article.
- knowledgeBaseArticlesEdit: Update an existing knowledge base article.
- knowledgeBaseArticlesRemove: Delete a knowledge base article.
## Directives
- include: Directs the executor to include this field or fragment only when the `if` argument is true.
- skip: Directs the executor to skip this field or fragment when the `if` argument is true.
- deprecated: Marks an element of a GraphQL schema as no longer supported.
- specifiedBy: Exposes a URL that specifies the behavior of this scalar.
- oneOf: Indicates exactly one field must be supplied and this field must not be `null`.
## Unions
- ActionsPayload: Union type for all action payloads.
## Scalars
- String: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Boolean: The `Boolean` scalar type represents `true` or `false`.
- Float: The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
- Int: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
- Date: undefined
- JSON: undefined
## Enums
- ConversationStatus: Status of a conversation in the inbox.
Determines the conversation's workflow state and visibility.
- SortDirection: undefined
- UserChatStatus: Presence state used for routing conversations and workload.
## Objects
- App: Third-party or internal app credential allowing scoped access for user groups.
Tokens are never exposed via queries — only returned once at creation.
- AppListResponse: Paginated response wrapper for app list queries.
Uses standard Pagination type from permission schema.
- AppTokenResult: Returned only from the appsAdd mutation.
Contains the access token which is shown once and never again.
- AssignedPayload: Payload for assigned action.
- Attachment: undefined
- Branch: undefined
- BranchListQueryResponse: undefined
- ColumnConfigItem: undefined
- CompaniesListResponse: Paginated company list response.
- Company: Company (account) entity that aggregates contacts, contact details, and CRM metadata.
- Conformity: undefined
- Conversation: A conversation in the inbox representing a communication thread between
a customer and the support team. Conversations are created from integrations
(messenger, email, WhatsApp, etc.) and managed through the inbox workflow.
- ConversationListResponse: Paginated list of conversations.
- ConversationMessage: A single message within a conversation. Uses a discriminated-union pattern
where the `type` field determines which content sub-object is populated.
- ConversationMessageListResponse: Paginated list of conversation messages.
- ConvertedToCardPayload: Payload for converted_to_card action.
- Customer: Customer/contact entity capturing personal details, subscription status, and engagement metadata.
- CustomerSegmentV2Membership: A customer's membership in a segments-v2 segment (active version).
- CustomersListResponse: Paginated customers response.
- Department: undefined
- DepartmentListQueryResponse: undefined
- EmailAddress: An email address with optional display name.
- EmailAttachment: Email-specific attachment metadata.
- Field: undefined
- FieldsGroup: undefined
- Form: undefined
- FormCode: A form code linking a brand to a form within a knowledge base article.
- FormsResponse: undefined
- FormsTotalCount: undefined
- FormSubmission: undefined
- FormSubmissionListResponse: undefined
- HealthEntity: undefined
- InboxField: Available custom field definitions for inbox entities.
- Integration: undefined
- KnowledgeBaseArticle: A knowledge base article containing help content, documentation, or guides.
Articles belong to categories within topics and support rich content, attachments, and reactions.
- KnowledgeBaseArticlesPaginated: Paginated list of knowledge base articles.
- KnowledgeBaseCategoriesPaginated: Paginated list of knowledge base categories.
- KnowledgeBaseCategory: A category that groups related knowledge base articles together.
Categories can be nested under parent categories for hierarchical organization.
- KnowledgeBaseParentCategory: A category with its nested child categories included.
- KnowledgeBaseSearchHit: A single search result hit from the knowledge base vector search.
- KnowledgeBaseSearchResult: Results from a knowledge base semantic search query.
- KnowledgeBaseTopic: A knowledge base topic — the top-level organizational unit.
Topics are associated with a brand and contain categories of articles.
They can be styled with custom colors and background images.
- KnowledgeBaseTopicsPaginated: Paginated list of knowledge base topics.
- LeadStageHistoryEntry: Single entry in a lead's stage-change history.
- LocationData: undefined
- LocationOption: undefined
- Logic: undefined
- MessageContext: Threading and forwarding context for a message.
- MessageDelivery: Delivery status tracking for a message.
- MessageEditEntry: A single edit in a message's edit history.
- MessageEmail: Email-specific envelope and body data.
- MessageEngage: Engage/campaign message content.
- MessageForm: Form submission content.
- MessageInteractive: Interactive message (buttons, quick replies, lists, carousels, flows, etc.).
- MessageMedia: Media content attached to a message.
- MessageOrder: Order/commerce message content (WhatsApp order flow).
- MessageOrderProductItem: A single product item in an order message.
- MessageOrigin: External origin tracking for a message.
- MessageReaction: A reaction on a message.
- MessageSender: Identifies who sent a message.
- MessageSystem: System-generated event shown inline in the conversation.
- MessageTemplate: Template message content.
- MessageText: Plain-text or rich-text message body.
- MessageVideoCall: Video call message content.
- MessengerApp: undefined
- ObjectListConfig: undefined
- OnboardingHistory: User-level onboarding history and progress
- OnboardingSection: Section-level completion status for user onboarding
- OnboardingSections: Section-level completion tracking for user onboarding
- PaginationInfo: Standard pagination metadata returned with all paginated list queries.
- ParticipantAddedPayload: Payload for participant_added action.
- ParticipantRemovedPayload: Payload for participant_removed action.
- PdfAttachment: A PDF attachment with its individual page images.
- Position: undefined
- PriceRange: Min/max price summary for variants.
- PriorityChangedPayload: Payload for priority_changed action.
- Product: Product entity including variants, pricing, and metadata.
- ProductCategory: Category (taxonomy) for products.
- ProductCategoryListResponse: undefined
- ProductDimensions: Physical dimensions of a product.
- ProductInventory: Inventory tracking for a product.
- ProductListResponse: undefined
- ProductOption: undefined
- ProductOptionValue: Option value for a product option (e.g., color: red).
- ProductSEO: SEO metadata for products and categories.
- ProductVariant: Variant of a product with pricing and option values.
- ScoreCategories: Breakdown of a user's score across different activity categories.
- ScoreCategoryEntry: Individual score category tracking (speed, quality, productivity, training, engagement).
- StatusChangedPayload: Payload for status_changed action.
- Submission: undefined
- SuccessResult: undefined
- Tag: Tag used for categorizing entities across the system.
- TaggedPayload: Payload for tagged action.
- TagsChangedPayload: Payload for tags_changed action.
- TagsPaginatedResponse: undefined
- TemplateRendered: Rendered snapshot of a template message.
- TemplateRenderedButton: undefined
- TemplateRenderedCarouselCard: undefined
- TemplateRenderedHeader: undefined
- TemplateRenderedLTO: undefined
- Throughput: undefined
- UnassignedPayload: Payload for unassigned action.
- UntaggedPayload: Payload for untagged action.
- User: Team member account with permissions, preferences, and structure assignments.
- UserDetailsType: undefined
- UserListResponse: Paginated response wrapper for user list queries.
- VariantOptionValue: Option selection on a specific variant.
- WAContact: A shared contact from a WhatsApp contacts message.
- WAContactName: A contact name structure (vCard-like).
- WALocation: Location message content.
- WAReferral: WhatsApp ad referral data (click-to-WhatsApp ads).
- WASticker: Sticker message content.
- WhatsappBusinessPhone: undefined
- WhatsappBusinessProfile: undefined
- WhatsappHealthStatus: undefined
- WhatsappIntegration: undefined
- Workspace: Workspace entity used for multi-workspace configurations (email, assets, member assignments).
## Inputs
- AttachmentInput: undefined
- FormCodeInput: Input for associating a form code with a knowledge base article.
- KnowledgeBaseArticleDoc: Input for creating or editing a knowledge base article.
- KnowledgeBaseCategoryDoc: Input for creating or editing a knowledge base category.
- KnowledgeBaseTopicDoc: Input for creating or editing a knowledge base topic.
- LocationDataInput: undefined
- LocationOptionInput: undefined
- LogicInput: undefined
- MessageContextInput: Input for threading and mention context.
- MessageMediaInput: Input for media message content.
- MessageSenderInput: Input for identifying the message sender.
- MessageTextInput: Input for text message content.
- objectListConfigInput: undefined
- PdfAttachmentInput: Input for uploading a PDF attachment with page images.
- SubmissionFilter: undefined