# Karzoun Docs

> Developer API, partner integrations, MCP, SDK, MiniApps, and Help Center for Karzoun Chat.

## Docs

- [appsAdd](https://docs.karzoun.chat/api-reference/mutations/appsAdd.md): 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](https://docs.karzoun.chat/api-reference/mutations/appsEdit.md): Update app name and expiration only. Permissions (userGroupId, allowAllPermission) are locked after creation.
- [appsRemove](https://docs.karzoun.chat/api-reference/mutations/appsRemove.md): Remove an app credential by id.
- [companiesAdd](https://docs.karzoun.chat/api-reference/mutations/companiesAdd.md): Create a new company record with core contact, address, and classification fields.
- [companiesEdit](https://docs.karzoun.chat/api-reference/mutations/companiesEdit.md): Update an existing company by id; supports partial edits of contact and CRM fields.
- [companiesEditByField](https://docs.karzoun.chat/api-reference/mutations/companiesEditByField.md): Patch company fields by selector for bulk or conditional updates.
- [companiesMerge](https://docs.karzoun.chat/api-reference/mutations/companiesMerge.md): Merge multiple companies into a primary record, applying provided field overrides.
- [companiesRemove](https://docs.karzoun.chat/api-reference/mutations/companiesRemove.md): Remove one or more companies; returns removed ids.
- [conformityAdd](https://docs.karzoun.chat/api-reference/mutations/conformityAdd.md)
- [conformityEdit](https://docs.karzoun.chat/api-reference/mutations/conformityEdit.md)
- [conversationConvertToCard](https://docs.karzoun.chat/api-reference/mutations/conversationConvertToCard.md): 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](https://docs.karzoun.chat/api-reference/mutations/conversationEditCustomFields.md): Updates custom field values on a conversation. Use this to add or modify custom metadata on conversations.
- [conversationMarkAsRead](https://docs.karzoun.chat/api-reference/mutations/conversationMarkAsRead.md): Marks a conversation as read by the current user. Clears unread indicators and updates read receipts.
- [conversationMessageAdd](https://docs.karzoun.chat/api-reference/mutations/conversationMessageAdd.md): 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](https://docs.karzoun.chat/api-reference/mutations/conversationMessageUpdate.md): Updates an existing conversation message. Can add reactions or change visibility.
- [conversationResolveAll](https://docs.karzoun.chat/api-reference/mutations/conversationResolveAll.md): Resolves (closes) all conversations matching the filter criteria. Use with caution as this performs a bulk status change. Returns the count of conversations resolved.
- [conversationsAssign](https://docs.karzoun.chat/api-reference/mutations/conversationsAssign.md): Assigns one or more conversations to a user or department. Use this to route conversations to the appropriate agent or team.
- [conversationsChangeStatus](https://docs.karzoun.chat/api-reference/mutations/conversationsChangeStatus.md): 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.
- [conversationsUnassign](https://docs.karzoun.chat/api-reference/mutations/conversationsUnassign.md): Removes assignment from conversations, making them unassigned. Conversations return to the general inbox queue.
- [customersAdd](https://docs.karzoun.chat/api-reference/mutations/customersAdd.md): Create a new customer/contact. The optional state can denote lead vs. customer pipelines.
- [customersChangeState](https://docs.karzoun.chat/api-reference/mutations/customersChangeState.md): Change the lifecycle state for a customer (e.g., lead → customer); value expects a known state key.
- [customersEdit](https://docs.karzoun.chat/api-reference/mutations/customersEdit.md): Update a customer by id with profile or CRM attributes.
- [customersEditByField](https://docs.karzoun.chat/api-reference/mutations/customersEditByField.md): Patch customer fields by selector for conditional/bulk edits.
- [customersMerge](https://docs.karzoun.chat/api-reference/mutations/customersMerge.md): Merge several customers into one, applying provided override fields.
- [customersRemove](https://docs.karzoun.chat/api-reference/mutations/customersRemove.md): Remove one or more customers; returns removed ids.
- [fieldsAdd](https://docs.karzoun.chat/api-reference/mutations/fieldsAdd.md)
- [fieldsEdit](https://docs.karzoun.chat/api-reference/mutations/fieldsEdit.md)
- [fieldsGroupsAdd](https://docs.karzoun.chat/api-reference/mutations/fieldsGroupsAdd.md)
- [fieldsGroupsEdit](https://docs.karzoun.chat/api-reference/mutations/fieldsGroupsEdit.md)
- [fieldsGroupsRemove](https://docs.karzoun.chat/api-reference/mutations/fieldsGroupsRemove.md)
- [fieldsRemove](https://docs.karzoun.chat/api-reference/mutations/fieldsRemove.md)
- [formSubmissionsSave](https://docs.karzoun.chat/api-reference/mutations/formSubmissionsSave.md)
- [knowledgeBaseArticlesAdd](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseArticlesAdd.md): Create a new knowledge base article.
- [knowledgeBaseArticlesEdit](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseArticlesEdit.md): Update an existing knowledge base article.
- [knowledgeBaseArticlesRemove](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseArticlesRemove.md): Delete a knowledge base article.
- [knowledgeBaseCategoriesAdd](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseCategoriesAdd.md): Create a new knowledge base category.
- [knowledgeBaseCategoriesEdit](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseCategoriesEdit.md): Update an existing knowledge base category.
- [knowledgeBaseCategoriesRemove](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseCategoriesRemove.md): Delete a knowledge base category and unlink its articles.
- [knowledgeBaseTopicsAdd](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseTopicsAdd.md): Create a new knowledge base topic.
- [knowledgeBaseTopicsEdit](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseTopicsEdit.md): Update an existing knowledge base topic.
- [knowledgeBaseTopicsRemove](https://docs.karzoun.chat/api-reference/mutations/knowledgeBaseTopicsRemove.md): Delete a knowledge base topic and disassociate its categories.
- [productCategoriesAdd](https://docs.karzoun.chat/api-reference/mutations/productCategoriesAdd.md): Create a product category.
- [productCategoriesEdit](https://docs.karzoun.chat/api-reference/mutations/productCategoriesEdit.md): Edit a product category by id.
- [productCategoriesRemove](https://docs.karzoun.chat/api-reference/mutations/productCategoriesRemove.md): Remove a product category by id.
- [productsAdd](https://docs.karzoun.chat/api-reference/mutations/productsAdd.md): Create a new product with pricing, taxonomy, and media.
- [productsEdit](https://docs.karzoun.chat/api-reference/mutations/productsEdit.md): Update an existing product by id.
- [productsRemove](https://docs.karzoun.chat/api-reference/mutations/productsRemove.md): Remove products by ids; returns status string.
- [tagsAdd](https://docs.karzoun.chat/api-reference/mutations/tagsAdd.md): Create a new tag.
- [tagsEdit](https://docs.karzoun.chat/api-reference/mutations/tagsEdit.md): Edit a tag by id.
- [tagsMerge](https://docs.karzoun.chat/api-reference/mutations/tagsMerge.md): Merge two tags (source into destination).
- [tagsRemove](https://docs.karzoun.chat/api-reference/mutations/tagsRemove.md): Remove a tag by id.
- [tagsTag](https://docs.karzoun.chat/api-reference/mutations/tagsTag.md): Attach/detach tags to target entities.
- [GraphQL Playground](https://docs.karzoun.chat/api-reference/playground.md): Open the interactive Karzoun GraphQL Playground to explore the public API.
- [appDetail](https://docs.karzoun.chat/api-reference/queries/appDetail.md): Fetch a single app credential by id.
- [apps](https://docs.karzoun.chat/api-reference/queries/apps.md): Paginated apps list with optional search filter. Returns { data, pagination } using paginateQuery.
- [branchDetail](https://docs.karzoun.chat/api-reference/queries/branchDetail.md)
- [branches](https://docs.karzoun.chat/api-reference/queries/branches.md): Paginated branches with optional status/parent filters, returns list + counts.
- [companies](https://docs.karzoun.chat/api-reference/queries/companies.md): Fetch paginated companies with filters, segmentation, and conformity context; returns paginated list.
- [companyCounts](https://docs.karzoun.chat/api-reference/queries/companyCounts.md): Return counts for companies matching the supplied filters (optionally scoped by "only").
- [companyDetail](https://docs.karzoun.chat/api-reference/queries/companyDetail.md): Load detailed company data by id including contacts, owners, and tags.
- [conversationCounts](https://docs.karzoun.chat/api-reference/queries/conversationCounts.md): Returns aggregated counts of conversations grouped by various criteria. Useful for dashboard statistics and inbox counters.
- [conversationDetail](https://docs.karzoun.chat/api-reference/queries/conversationDetail.md): Retrieves complete details of a specific conversation by ID. Includes customer info, assigned agent, tags, and metadata.
- [conversationMessage](https://docs.karzoun.chat/api-reference/queries/conversationMessage.md): Retrieves a single conversation message by its ID. Use this to get full details of a specific message.
- [conversationMessages](https://docs.karzoun.chat/api-reference/queries/conversationMessages.md): Retrieves a paginated list of messages within a specific conversation. Returns messages in reverse chronological order by default.
- [conversations](https://docs.karzoun.chat/api-reference/queries/conversations.md): 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.
- [conversationsTotalUnreadCount](https://docs.karzoun.chat/api-reference/queries/conversationsTotalUnreadCount.md): Returns the total count of unread conversations for the current user. Used for notification badges and alerts.
- [currentUser](https://docs.karzoun.chat/api-reference/queries/currentUser.md): Resolve the profile of the currently authenticated user.
- [customerCounts](https://docs.karzoun.chat/api-reference/queries/customerCounts.md): Return aggregated counts for customers matching filters (optionally scoped by "only" or source).
- [customerDetail](https://docs.karzoun.chat/api-reference/queries/customerDetail.md): Load a customer by id with full profile, ownership, tags, and integration info.
- [customers](https://docs.karzoun.chat/api-reference/queries/customers.md): Fetch paginated customers with filtering, segmentation, and conformity context; returns paginated list.
- [departmentDetail](https://docs.karzoun.chat/api-reference/queries/departmentDetail.md)
- [departments](https://docs.karzoun.chat/api-reference/queries/departments.md): Paginated departments with optional status/parent filters, returns list + counts.
- [fieldsCombinedByContentType](https://docs.karzoun.chat/api-reference/queries/fieldsCombinedByContentType.md)
- [fieldsDefaultColumnsConfig](https://docs.karzoun.chat/api-reference/queries/fieldsDefaultColumnsConfig.md)
- [fieldsGetDetail](https://docs.karzoun.chat/api-reference/queries/fieldsGetDetail.md)
- [fieldsGetTypes](https://docs.karzoun.chat/api-reference/queries/fieldsGetTypes.md)
- [fieldsGroups](https://docs.karzoun.chat/api-reference/queries/fieldsGroups.md)
- [formDetail](https://docs.karzoun.chat/api-reference/queries/formDetail.md)
- [formSubmissionDetail](https://docs.karzoun.chat/api-reference/queries/formSubmissionDetail.md)
- [formSubmissions](https://docs.karzoun.chat/api-reference/queries/formSubmissions.md)
- [formSubmissionsTotalCount](https://docs.karzoun.chat/api-reference/queries/formSubmissionsTotalCount.md)
- [forms](https://docs.karzoun.chat/api-reference/queries/forms.md)
- [formsTotalCount](https://docs.karzoun.chat/api-reference/queries/formsTotalCount.md)
- [inboxFields](https://docs.karzoun.chat/api-reference/queries/inboxFields.md): Retrieves available custom fields for inbox entities. Returns field definitions for customers, conversations, and devices.
- [knowledgeBaseArticleDetail](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseArticleDetail.md): Retrieve a single knowledge base article by ID.
- [knowledgeBaseArticles](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseArticles.md): List knowledge base articles with pagination, search, sorting, and filtering.
- [knowledgeBaseArticlesTotalCount](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseArticlesTotalCount.md): Return the total number of articles matching the given filters.
- [knowledgeBaseCategories](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseCategories.md): List knowledge base categories with pagination. Filter by topic, code, or icon.
- [knowledgeBaseCategoriesGetLast](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseCategoriesGetLast.md): Return the most recently created knowledge base category.
- [knowledgeBaseCategoriesTotalCount](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseCategoriesTotalCount.md): Return the total number of categories matching the given filters.
- [knowledgeBaseCategoryDetail](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseCategoryDetail.md): Retrieve a single knowledge base category by ID.
- [knowledgeBaseSearch](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseSearch.md): Perform a semantic search across knowledge base articles using vector similarity.
- [knowledgeBaseTopicDetail](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseTopicDetail.md)
- [knowledgeBaseTopics](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseTopics.md)
- [knowledgeBaseTopicsTotalCount](https://docs.karzoun.chat/api-reference/queries/knowledgeBaseTopicsTotalCount.md): Return the total number of knowledge base topics.
- [productCategories](https://docs.karzoun.chat/api-reference/queries/productCategories.md): List product categories with optional workspace filter and tree traversal.
- [productCategoryDetail](https://docs.karzoun.chat/api-reference/queries/productCategoryDetail.md): Fetch single product category detail by id.
- [productCountByTags](https://docs.karzoun.chat/api-reference/queries/productCountByTags.md): Count products grouped by tag.
- [productDetail](https://docs.karzoun.chat/api-reference/queries/productDetail.md): Detailed product by id.
- [products](https://docs.karzoun.chat/api-reference/queries/products.md): List products with filtering, segmentation, and pagination.
- [tagDetail](https://docs.karzoun.chat/api-reference/queries/tagDetail.md): Fetch tag details by id.
- [tags](https://docs.karzoun.chat/api-reference/queries/tags.md): Paginated tags with search and hierarchical filters.
- [tagsQueryCount](https://docs.karzoun.chat/api-reference/queries/tagsQueryCount.md): Count tags for a given type/search.
- [userDetail](https://docs.karzoun.chat/api-reference/queries/userDetail.md): Load a single user with extended details by identifier.
- [users](https://docs.karzoun.chat/api-reference/queries/users.md): Paginated users list with filters for workspaces, departments, branches, status, and availability. Returns { list, totalCount } in a single response using paginateQuery.
- [ActionsPayload](https://docs.karzoun.chat/api-reference/types/ActionsPayload.md): Union type for all action payloads.
- [App](https://docs.karzoun.chat/api-reference/types/App.md): Third-party or internal app credential allowing scoped access for user groups. Tokens are never exposed via queries — only returned once at creation.
- [AppListResponse](https://docs.karzoun.chat/api-reference/types/AppListResponse.md): Paginated response wrapper for app list queries. Uses standard Pagination type from permission schema.
- [AppTokenResult](https://docs.karzoun.chat/api-reference/types/AppTokenResult.md): Returned only from the appsAdd mutation. Contains the access token which is shown once and never again.
- [AssignedPayload](https://docs.karzoun.chat/api-reference/types/AssignedPayload.md): Payload for assigned action.
- [Attachment](https://docs.karzoun.chat/api-reference/types/Attachment.md)
- [Branch](https://docs.karzoun.chat/api-reference/types/Branch.md)
- [BranchListQueryResponse](https://docs.karzoun.chat/api-reference/types/BranchListQueryResponse.md)
- [ColumnConfigItem](https://docs.karzoun.chat/api-reference/types/ColumnConfigItem.md)
- [CompaniesListResponse](https://docs.karzoun.chat/api-reference/types/CompaniesListResponse.md): Paginated company list response.
- [Company](https://docs.karzoun.chat/api-reference/types/Company.md): Company (account) entity that aggregates contacts, contact details, and CRM metadata.
- [Conformity](https://docs.karzoun.chat/api-reference/types/Conformity.md)
- [Conversation](https://docs.karzoun.chat/api-reference/types/Conversation.md): 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](https://docs.karzoun.chat/api-reference/types/ConversationListResponse.md): Paginated list of conversations.
- [ConversationMessage](https://docs.karzoun.chat/api-reference/types/ConversationMessage.md): A single message within a conversation. Uses a discriminated-union pattern where the `type` field determines which content sub-object is populated.
- [ConversationMessageListResponse](https://docs.karzoun.chat/api-reference/types/ConversationMessageListResponse.md): Paginated list of conversation messages.
- [ConversationStatus](https://docs.karzoun.chat/api-reference/types/ConversationStatus.md): Status of a conversation in the inbox. Determines the conversation's workflow state and visibility.
- [ConvertedToCardPayload](https://docs.karzoun.chat/api-reference/types/ConvertedToCardPayload.md): Payload for converted_to_card action.
- [Customer](https://docs.karzoun.chat/api-reference/types/Customer.md): Customer/contact entity capturing personal details, subscription status, and engagement metadata.
- [CustomerSegmentV2Membership](https://docs.karzoun.chat/api-reference/types/CustomerSegmentV2Membership.md): A customer's membership in a segments-v2 segment (active version).
- [CustomersListResponse](https://docs.karzoun.chat/api-reference/types/CustomersListResponse.md): Paginated customers response.
- [Department](https://docs.karzoun.chat/api-reference/types/Department.md)
- [DepartmentListQueryResponse](https://docs.karzoun.chat/api-reference/types/DepartmentListQueryResponse.md)
- [EmailAddress](https://docs.karzoun.chat/api-reference/types/EmailAddress.md): An email address with optional display name.
- [EmailAttachment](https://docs.karzoun.chat/api-reference/types/EmailAttachment.md): Email-specific attachment metadata.
- [Field](https://docs.karzoun.chat/api-reference/types/Field.md)
- [FieldsGroup](https://docs.karzoun.chat/api-reference/types/FieldsGroup.md)
- [Form](https://docs.karzoun.chat/api-reference/types/Form.md)
- [FormCode](https://docs.karzoun.chat/api-reference/types/FormCode.md): A form code linking a brand to a form within a knowledge base article.
- [FormSubmission](https://docs.karzoun.chat/api-reference/types/FormSubmission.md)
- [FormSubmissionListResponse](https://docs.karzoun.chat/api-reference/types/FormSubmissionListResponse.md)
- [FormsResponse](https://docs.karzoun.chat/api-reference/types/FormsResponse.md)
- [FormsTotalCount](https://docs.karzoun.chat/api-reference/types/FormsTotalCount.md)
- [HealthEntity](https://docs.karzoun.chat/api-reference/types/HealthEntity.md)
- [InboxField](https://docs.karzoun.chat/api-reference/types/InboxField.md): Available custom field definitions for inbox entities.
- [Integration](https://docs.karzoun.chat/api-reference/types/Integration.md)
- [KnowledgeBaseArticle](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseArticle.md): A knowledge base article containing help content, documentation, or guides. Articles belong to categories within topics and support rich content, attachments, and reactions.
- [KnowledgeBaseArticlesPaginated](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseArticlesPaginated.md): Paginated list of knowledge base articles.
- [KnowledgeBaseCategoriesPaginated](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseCategoriesPaginated.md): Paginated list of knowledge base categories.
- [KnowledgeBaseCategory](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseCategory.md): A category that groups related knowledge base articles together. Categories can be nested under parent categories for hierarchical organization.
- [KnowledgeBaseParentCategory](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseParentCategory.md): A category with its nested child categories included.
- [KnowledgeBaseSearchHit](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseSearchHit.md): A single search result hit from the knowledge base vector search.
- [KnowledgeBaseSearchResult](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseSearchResult.md): Results from a knowledge base semantic search query.
- [KnowledgeBaseTopic](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseTopic.md): 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](https://docs.karzoun.chat/api-reference/types/KnowledgeBaseTopicsPaginated.md): Paginated list of knowledge base topics.
- [LeadStageHistoryEntry](https://docs.karzoun.chat/api-reference/types/LeadStageHistoryEntry.md): Single entry in a lead's stage-change history.
- [LocationData](https://docs.karzoun.chat/api-reference/types/LocationData.md)
- [LocationOption](https://docs.karzoun.chat/api-reference/types/LocationOption.md)
- [Logic](https://docs.karzoun.chat/api-reference/types/Logic.md)
- [MessageContext](https://docs.karzoun.chat/api-reference/types/MessageContext.md): Threading and forwarding context for a message.
- [MessageDelivery](https://docs.karzoun.chat/api-reference/types/MessageDelivery.md): Delivery status tracking for a message.
- [MessageEditEntry](https://docs.karzoun.chat/api-reference/types/MessageEditEntry.md): A single edit in a message's edit history.
- [MessageEmail](https://docs.karzoun.chat/api-reference/types/MessageEmail.md): Email-specific envelope and body data.
- [MessageEngage](https://docs.karzoun.chat/api-reference/types/MessageEngage.md): Engage/campaign message content.
- [MessageForm](https://docs.karzoun.chat/api-reference/types/MessageForm.md): Form submission content.
- [MessageInteractive](https://docs.karzoun.chat/api-reference/types/MessageInteractive.md): Interactive message (buttons, quick replies, lists, carousels, flows, etc.).
- [MessageMedia](https://docs.karzoun.chat/api-reference/types/MessageMedia.md): Media content attached to a message.
- [MessageOrder](https://docs.karzoun.chat/api-reference/types/MessageOrder.md): Order/commerce message content (WhatsApp order flow).
- [MessageOrderProductItem](https://docs.karzoun.chat/api-reference/types/MessageOrderProductItem.md): A single product item in an order message.
- [MessageOrigin](https://docs.karzoun.chat/api-reference/types/MessageOrigin.md): External origin tracking for a message.
- [MessageReaction](https://docs.karzoun.chat/api-reference/types/MessageReaction.md): A reaction on a message.
- [MessageSender](https://docs.karzoun.chat/api-reference/types/MessageSender.md): Identifies who sent a message.
- [MessageSystem](https://docs.karzoun.chat/api-reference/types/MessageSystem.md): System-generated event shown inline in the conversation.
- [MessageTemplate](https://docs.karzoun.chat/api-reference/types/MessageTemplate.md): Template message content.
- [MessageText](https://docs.karzoun.chat/api-reference/types/MessageText.md): Plain-text or rich-text message body.
- [MessageVideoCall](https://docs.karzoun.chat/api-reference/types/MessageVideoCall.md): Video call message content.
- [MessengerApp](https://docs.karzoun.chat/api-reference/types/MessengerApp.md)
- [ObjectListConfig](https://docs.karzoun.chat/api-reference/types/ObjectListConfig.md)
- [OnboardingHistory](https://docs.karzoun.chat/api-reference/types/OnboardingHistory.md): User-level onboarding history and progress
- [OnboardingSection](https://docs.karzoun.chat/api-reference/types/OnboardingSection.md): Section-level completion status for user onboarding
- [OnboardingSections](https://docs.karzoun.chat/api-reference/types/OnboardingSections.md): Section-level completion tracking for user onboarding
- [PaginationInfo](https://docs.karzoun.chat/api-reference/types/PaginationInfo.md): Standard pagination metadata returned with all paginated list queries.
- [ParticipantAddedPayload](https://docs.karzoun.chat/api-reference/types/ParticipantAddedPayload.md): Payload for participant_added action.
- [ParticipantRemovedPayload](https://docs.karzoun.chat/api-reference/types/ParticipantRemovedPayload.md): Payload for participant_removed action.
- [PdfAttachment](https://docs.karzoun.chat/api-reference/types/PdfAttachment.md): A PDF attachment with its individual page images.
- [Position](https://docs.karzoun.chat/api-reference/types/Position.md)
- [PriceRange](https://docs.karzoun.chat/api-reference/types/PriceRange.md): Min/max price summary for variants.
- [PriorityChangedPayload](https://docs.karzoun.chat/api-reference/types/PriorityChangedPayload.md): Payload for priority_changed action.
- [Product](https://docs.karzoun.chat/api-reference/types/Product.md): Product entity including variants, pricing, and metadata.
- [ProductCategory](https://docs.karzoun.chat/api-reference/types/ProductCategory.md): Category (taxonomy) for products.
- [ProductCategoryListResponse](https://docs.karzoun.chat/api-reference/types/ProductCategoryListResponse.md)
- [ProductDimensions](https://docs.karzoun.chat/api-reference/types/ProductDimensions.md): Physical dimensions of a product.
- [ProductInventory](https://docs.karzoun.chat/api-reference/types/ProductInventory.md): Inventory tracking for a product.
- [ProductListResponse](https://docs.karzoun.chat/api-reference/types/ProductListResponse.md)
- [ProductOption](https://docs.karzoun.chat/api-reference/types/ProductOption.md)
- [ProductOptionValue](https://docs.karzoun.chat/api-reference/types/ProductOptionValue.md): Option value for a product option (e.g., color: red).
- [ProductSEO](https://docs.karzoun.chat/api-reference/types/ProductSEO.md): SEO metadata for products and categories.
- [ProductVariant](https://docs.karzoun.chat/api-reference/types/ProductVariant.md): Variant of a product with pricing and option values.
- [ScoreCategories](https://docs.karzoun.chat/api-reference/types/ScoreCategories.md): Breakdown of a user's score across different activity categories.
- [ScoreCategoryEntry](https://docs.karzoun.chat/api-reference/types/ScoreCategoryEntry.md): Individual score category tracking (speed, quality, productivity, training, engagement).
- [SortDirection](https://docs.karzoun.chat/api-reference/types/SortDirection.md)
- [StatusChangedPayload](https://docs.karzoun.chat/api-reference/types/StatusChangedPayload.md): Payload for status_changed action.
- [Submission](https://docs.karzoun.chat/api-reference/types/Submission.md)
- [SuccessResult](https://docs.karzoun.chat/api-reference/types/SuccessResult.md)
- [Tag](https://docs.karzoun.chat/api-reference/types/Tag.md): Tag used for categorizing entities across the system.
- [TaggedPayload](https://docs.karzoun.chat/api-reference/types/TaggedPayload.md): Payload for tagged action.
- [TagsChangedPayload](https://docs.karzoun.chat/api-reference/types/TagsChangedPayload.md): Payload for tags_changed action.
- [TagsPaginatedResponse](https://docs.karzoun.chat/api-reference/types/TagsPaginatedResponse.md)
- [TemplateRendered](https://docs.karzoun.chat/api-reference/types/TemplateRendered.md): Rendered snapshot of a template message.
- [TemplateRenderedButton](https://docs.karzoun.chat/api-reference/types/TemplateRenderedButton.md)
- [TemplateRenderedCarouselCard](https://docs.karzoun.chat/api-reference/types/TemplateRenderedCarouselCard.md)
- [TemplateRenderedHeader](https://docs.karzoun.chat/api-reference/types/TemplateRenderedHeader.md)
- [TemplateRenderedLTO](https://docs.karzoun.chat/api-reference/types/TemplateRenderedLTO.md)
- [Throughput](https://docs.karzoun.chat/api-reference/types/Throughput.md)
- [UnassignedPayload](https://docs.karzoun.chat/api-reference/types/UnassignedPayload.md): Payload for unassigned action.
- [UntaggedPayload](https://docs.karzoun.chat/api-reference/types/UntaggedPayload.md): Payload for untagged action.
- [User](https://docs.karzoun.chat/api-reference/types/User.md): Team member account with permissions, preferences, and structure assignments.
- [UserChatStatus](https://docs.karzoun.chat/api-reference/types/UserChatStatus.md): Presence state used for routing conversations and workload.
- [UserDetailsType](https://docs.karzoun.chat/api-reference/types/UserDetailsType.md)
- [UserListResponse](https://docs.karzoun.chat/api-reference/types/UserListResponse.md): Paginated response wrapper for user list queries.
- [VariantOptionValue](https://docs.karzoun.chat/api-reference/types/VariantOptionValue.md): Option selection on a specific variant.
- [WAContact](https://docs.karzoun.chat/api-reference/types/WAContact.md): A shared contact from a WhatsApp contacts message.
- [WAContactName](https://docs.karzoun.chat/api-reference/types/WAContactName.md): A contact name structure (vCard-like).
- [WALocation](https://docs.karzoun.chat/api-reference/types/WALocation.md): Location message content.
- [WAReferral](https://docs.karzoun.chat/api-reference/types/WAReferral.md): WhatsApp ad referral data (click-to-WhatsApp ads).
- [WAReferralWelcomeMessage](https://docs.karzoun.chat/api-reference/types/WAReferralWelcomeMessage.md): Greeting text attached to a CTWA ad referral.
- [WASticker](https://docs.karzoun.chat/api-reference/types/WASticker.md): Sticker message content.
- [WhatsappBusinessPhone](https://docs.karzoun.chat/api-reference/types/WhatsappBusinessPhone.md)
- [WhatsappBusinessProfile](https://docs.karzoun.chat/api-reference/types/WhatsappBusinessProfile.md)
- [WhatsappHealthStatus](https://docs.karzoun.chat/api-reference/types/WhatsappHealthStatus.md)
- [WhatsappIntegration](https://docs.karzoun.chat/api-reference/types/WhatsappIntegration.md)
- [Workspace](https://docs.karzoun.chat/api-reference/types/Workspace.md): Workspace entity used for multi-workspace configurations (email, assets, member assignments).
- [Changelog](https://docs.karzoun.chat/changelog.md): Product and API updates for Karzoun Chat.
- [Authentication](https://docs.karzoun.chat/developers/getting-started/authentication.md): App tokens and request headers for the Karzoun public GraphQL API.
- [Quickstart](https://docs.karzoun.chat/developers/getting-started/quickstart.md): Make your first Karzoun GraphQL API call in under five minutes.
- [Errors](https://docs.karzoun.chat/developers/guides/errors.md): Understand GraphQL and HTTP error shapes from the Karzoun API.
- [Pagination](https://docs.karzoun.chat/developers/guides/pagination.md): Paginate list queries in the Karzoun GraphQL API.
- [Webhooks](https://docs.karzoun.chat/developers/guides/webhooks.md): Subscribe to Karzoun platform events — conversations, customers, WhatsApp flows, tasks, and more.
- [Overview](https://docs.karzoun.chat/developers/index.md): Build integrations with the Karzoun public GraphQL API — app tokens, webhooks, MCP, SDK, and MiniApps.
- [Email channels](https://docs.karzoun.chat/help-center/guides/channels/email-channels.md): Choose between Karzoun Business Email and IMAP/SMTP, when to use each, and how they fit together with Inbox.
- [WhatsApp calling](https://docs.karzoun.chat/help-center/guides/whatsapp/whatsapp-calling.md): Enable WhatsApp voice calls, set business hours, record calls, and manage voicemail from Karzoun.
- [WhatsApp ads that open a chat](https://docs.karzoun.chat/help-center/guides/whatsapp/whatsapp-ctwa-ads.md): Why use WhatsApp ads, how to design the first message, connect it in Facebook Ads Manager, see the ad in Inbox, and get more replies with Automations.
- [Help Center](https://docs.karzoun.chat/help-center/index.md): Day-to-day Karzoun guides for teams — inbox, WhatsApp, contacts, automations, and billing. Full library in Arabic.
- [Conversations run. Automation works. Sales grow.](https://docs.karzoun.chat/index.md): Karzoun Docs for teams, partners, and builders — Help Center, Partners, and Developer guides in one place.
- [Agent patterns](https://docs.karzoun.chat/mcp-server/guides/agent-patterns.md): Reliable prompts and workflows for agents using Karzoun MCP tools.
- [How it works](https://docs.karzoun.chat/mcp-server/guides/how-it-works.md): How Karzoun MCP maps tools to GraphQL operations.
- [Troubleshooting](https://docs.karzoun.chat/mcp-server/guides/troubleshooting.md): Fix common Karzoun MCP connection, permission, and size errors.
- [MCP](https://docs.karzoun.chat/mcp-server/index.md): Connect Cursor, Claude, and server-side agents to Karzoun via Model Context Protocol.
- [Connect AI apps to hosted MCP](https://docs.karzoun.chat/mcp-server/setup/ai-connectors.md): Connect Claude, Manus, ChatGPT, and remote Cursor to Karzoun's hosted MCP endpoint.
- [Claude Desktop setup (stdio)](https://docs.karzoun.chat/mcp-server/setup/claude-desktop.md): Connect Claude Desktop to Karzoun via the local MCP server.
- [Cursor setup (stdio)](https://docs.karzoun.chat/mcp-server/setup/cursor.md): Run Karzoun MCP locally so Cursor's agent can call your workspace GraphQL API as tools.
- [Hosted MCP (/mcp)](https://docs.karzoun.chat/mcp-server/setup/hosted.md): Call Karzoun MCP over Streamable HTTP from your backend or cloud AI apps.
- [MCP security](https://docs.karzoun.chat/mcp-server/setup/security.md): Token hygiene, scoping, and incident response for Karzoun MCP.
- [MCP tool catalog](https://docs.karzoun.chat/mcp-server/tools/catalog.md): All MCP tools exposed by the Karzoun MCP server, mapped 1:1 to public GraphQL operations.
- [Architecture](https://docs.karzoun.chat/miniapps/architecture.md): How Karzoun MiniApps are modeled, executed, and reviewed.
- [Dropbox](https://docs.karzoun.chat/miniapps/examples/dropbox.md): Bearer-token file storage MiniApp example with actions and triggers.
- [GitHub](https://docs.karzoun.chat/miniapps/examples/github.md): Bearer-token developer platform MiniApp example with header-based events and HMAC verification.
- [Examples](https://docs.karzoun.chat/miniapps/examples/index.md): Reference MiniApp definitions for common integration patterns.
- [Salla](https://docs.karzoun.chat/miniapps/examples/salla.md): OAuth 2.0 e-commerce MiniApp example with sync and customer extraction.
- [Slack](https://docs.karzoun.chat/miniapps/examples/slack.md): Bearer-token messaging MiniApp example with RPC sources and chained requests.
- [Quickstart](https://docs.karzoun.chat/miniapps/getting-started/quickstart.md): Build a minimal MiniApp definition with bearer-token auth and one action.
- [Actions](https://docs.karzoun.chat/miniapps/guides/actions.md): Requests, App Functions, parameters, and chaining for MiniApp actions.
- [Authentication](https://docs.karzoun.chat/miniapps/guides/authentication.md): Bearer tokens, HTTP Basic, custom headers, and OAuth 2.0 for MiniApp installs.
- [Best practices](https://docs.karzoun.chat/miniapps/guides/best-practices.md): Security, quality, and submission guidance for MiniApp builders.
- [Dynamic data sources](https://docs.karzoun.chat/miniapps/guides/dynamic-data-sources.md): Define RPC-backed dropdowns for MiniApp action forms.
- [E-commerce](https://docs.karzoun.chat/miniapps/guides/ecommerce.md): Connect storefront platforms to Karzoun orders, customers, products, and carts.
- [Marketplace listing](https://docs.karzoun.chat/miniapps/guides/marketplace.md): Metadata, icons, and copy that control your MiniApp's Marketplace listing.
- [Submit for review](https://docs.karzoun.chat/miniapps/guides/submission.md): Package and submit your MiniApp definition to Karzoun for review and approval.
- [Sync](https://docs.karzoun.chat/miniapps/guides/sync.md): Bulk import and realtime commerce sync for e-commerce MiniApps.
- [Triggers](https://docs.karzoun.chat/miniapps/guides/triggers.md): Define automation trigger nodes that fire from MiniApp webhook events.
- [Troubleshooting](https://docs.karzoun.chat/miniapps/guides/troubleshooting.md): Common issues while building and testing a MiniApp definition.
- [Webhooks](https://docs.karzoun.chat/miniapps/guides/webhooks.md): Configure inbound webhook processing — event extraction, verification, and customer extraction.
- [MiniApps](https://docs.karzoun.chat/miniapps/index.md): Build JSON-driven integrations for the Karzoun Marketplace — auth, actions, triggers, and webhooks.
- [API reference](https://docs.karzoun.chat/miniapps/reference/api-reference.md): REST endpoints and GraphQL operations for MiniApps.
- [Document schema](https://docs.karzoun.chat/miniapps/reference/document-schema.md): Required top-level fields for every MiniApp JSON definition.
- [Partners](https://docs.karzoun.chat/partners/index.md): Partner onboarding, whitelabel, and embedded apps.
- [Partner onboarding](https://docs.karzoun.chat/partners/onboarding.md): Steps to onboard as a Karzoun partner, from sandbox to production.
- [Whitelabel](https://docs.karzoun.chat/partners/whitelabel.md): Offer Karzoun under your own brand with a custom domain.
- [Dashboard SDK](https://docs.karzoun.chat/sdk/dashboard-sdk.md): Build inbox dashboard panel apps with the Karzoun Dashboard SDK.
- [SDK](https://docs.karzoun.chat/sdk/index.md): Karzoun Dashboard SDK and tracking pixel.
- [Karzoun Pixel](https://docs.karzoun.chat/sdk/pixel.md): Embed the Karzoun tracking pixel to identify website visitors and sync customer data.