Connecting to ZohoDesk

To authenticate to ZohoDesk, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with ZohoDesk. To do so, go to Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your Oauth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (com, eu, in, cn etc.), defaults to com and Organization. Set Organization to Organization Id that you can find in Organizations table.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the client_id that is specified in you app settings.
OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
CallbackURL: Set this to the Redirect URI that is specified in your app settings
Domain: Optionally, set this in ProfileSettings to your ZohoDesk account domain
Organization: Set this in ProfileSettings to your Organizaiton Id. See Organizations table for details

Example connection string:

Profile=C:\profiles\ZohoDesk.apip;ProfileSettings='Domain=your_domain;Organization=your_organization_id';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Usage Examples

Account Management

Search accounts by name:

SELECT * FROM AccountSearch WHERE AccountName = 'Acme Corporation'

Contact Management

Search contacts by email:

SELECT * FROM ContactSearch WHERE Email = '[email protected]'

Filter contact accounts (requires ContactId):

SELECT * FROM ContactAccounts WHERE ContactId = 'contact123'

Ticket Management

Search tickets by status:

SELECT * FROM TicketSearch WHERE Status = 'Open'

Filter tickets by assignee:

SELECT * FROM TicketSearch WHERE AssigneeId = 'agent123'

Article Management

Search articles by category:

SELECT * FROM ArticleSearch WHERE CategoryId = '456789'

Search articles by title:

SELECT * FROM ArticleSearch

User Management

Filter agents by status:

SELECT * FROM Agents WHERE Status = 'ACTIVE'

Filter agents by confirmation status:

SELECT * FROM Agents WHERE IsConfirmed = 'true'

Time Tracking

Filter account time entries (requires AccountId):

SELECT * FROM AccountTimeEntry WHERE AccountId = 'acc123' AND BillStatus = 'BILLABLE'

Filter contact time entries (requires ContactId):

SELECT * FROM ContactTimeEntry WHERE ContactId = 'contact123' AND FetchModule = 'tickets'

Activity Management

Search activities by priority:

SELECT * FROM ActivitiesSearch WHERE Priority = 'High'

Call Management

Search calls by assignee:

SELECT * FROM CallSearch WHERE AssigneeId = 'agent456'

Filter calls by completion status:

SELECT * FROM Calls WHERE IsCompleted = 'true'

Event Management

Search events by assignee:

SELECT * FROM EventSearch WHERE AssigneeId = 'agent789'

Filter events by completion:

SELECT * FROM Events WHERE IsCompleted = 'false'

Community Management

Filter community topics by type:

SELECT * FROM CommunityTopics WHERE Type = 'Question'

Search community users by id:

SELECT * FROM CommunityUsers WHERE Id = '1234'

Department and Organization

Filter DepartmentAgents (requires Departmentid):

SELECT * FROM DepartmentAgents WHERE DepartmentId = 'dept123' AND SearchString = 'support'

Search groups by name:

SELECT * FROM Groups WHERE SearchKeyword = 'name'

Task Management

Search tasks by assignee:

SELECT * FROM TaskSearch WHERE AssigneeId = 'agent123'

Filter tasks by status:

SELECT * FROM TaskSearch WHERE Status = 'Completed'

Product Management

Search products by name:

SELECT * FROM ProductSearch WHERE ProductName = 'Software License'

Filter product accounts (requires ProductId):

SELECT * FROM ProductAccounts WHERE ProductId = 'prod123'

Contract Management

Filter contracts by AccountId:

SELECT * FROM Contracts WHERE AccountId = '1234'

Filter contract comments by Id:

SELECT * FROM ContractComments WHERE ContractID = '456789'

Analytics and Dashboard

Filter DashboardResponseCount (requires Duration, GroupBy):

SELECT * FROM DashboardResponseCount WHERE Duration = 'LAST_30_DAYS' AND GroupBy = 'agent' AND Channel = 'Email'

Filter DashboardResponseTime (requires Duration, GroupBy, IsFirstResponse):

SELECT * FROM DashboardResponseTime WHERE Duration = 'LAST_7_DAYS' AND GroupBy = 'department' AND IsFirstResponse = 'true' AND DepartmentId = '123456'

Skills and Teams

Filter agent skills (requires AgentId):

SELECT * FROM AgentSkills WHERE AgentId = 'agent123'

Filter TeamMembers (requires TeamId):

SELECT * FROM TeamMembers WHERE TeamId = 'team456'

Business Hours and Holidays

Filter business hours by status:

SELECT * FROM BusinessHours WHERE Status = 'active'

Filter holiday list by Status:

SELECT * FROM HolidayList WHERE Status = 'active'

Attachments and Files

Filter Attachments (requires Module, ModuleId):

SELECT * FROM Attachments WHERE FetchModule = 'Tickets' AND ModuleId = '123456'

Filter attachments by include parameter:

SELECT * FROM Attachments WHERE Include = 'metadata'

Roles and Permissions

Search profiles by string:

SELECT * FROM Profiles WHERE SearchString = 'admin'

Filter roles by string:

SELECT * FROM Roles WHERE SearchString = 'admin'

Views and Layouts

Filter views by department:

SELECT * FROM Views WHERE DepartmentId = '555666'

Filter layouts by module:

SELECT * FROM Layouts WHERE Module = 'tickets'

Labels and Categories

Filter labels by searchKeyword:

SELECT * FROM Labels WHERE SearchKeyword = 'abc'

Filter ticket tags (requires TicketId):

SELECT * FROM TicketTags WHERE TicketId = '12345'

Automation and Rules

Filter blueprints by module:

SELECT * FROM Blueprints WHERE Module = 'tickets'

Filter validation rules by department:

SELECT * FROM ValidationRules WHERE DepartmentId = '12345'

Organization and Setup

Filter organizations by Domain:

SELECT * FROM Organizations WHERE IncludeCustomDomain = 'true'

SELECT * FROM Channels

Integration and Services

Filter domains by IsApplied:

SELECT * FROM Domains WHERE IsApplied = 'true'

List mail configurations :

SELECT * FROM MailConfigurations

Knowledge Base Management

List KB sections :

SELECT * FROM KbSections

Filter KB root categories by help center:

SELECT * FROM KbRootCategories WHERE HelpCenterId = '456123'

Article Translation Management

Filter translation attachments (requires ArticleId, Locale):

SELECT * FROM TranslationAttachments WHERE ArticleId = 'article123' AND Locale = 'en_US'

Filter translation comments (requires ArticleId, Locale):

SELECT * FROM TranslationComments WHERE ArticleId = 'article123' AND Locale = 'en_US' AND Include = 'attachments'

Agent and User Management

Filter agent availability by department:

SELECT * FROM AgentAvailability WHERE DepartmentId = '321654'

Filter AgentByEmail (requires EmailId):

SELECT * FROM AgentByEmail WHERE EmailId = 'email123'

Time Entry Management

Filter account time entry by bill status:

SELECT * FROM AccountTimeEntry WHERE BillStatus = 'BILLABLE'

Filter agent time entry (requires AgentId):

SELECT * FROM AgentTimeEntry WHERE AgentId = 'agent123' AND FetchModule = 'calls'

Timer Management

Filter ActiveTimer (requires Module, ModuleId):

SELECT * FROM ActiveTimer WHERE FetchModule = 'Tickets' AND ModuleId = '123456'

Filter my active timers (requires DepartmentId):

SELECT * FROM MyActiveTimers WHERE DepartmentId = '123456'

Ticket Related Tables

Filter ticket activities (requires TicketId):

SELECT * FROM TicketActivities WHERE TicketId = '12345'

Filter ticket comments (requires TicketId):

SELECT * FROM TicketComments WHERE TicketId = '12345' AND Include = 'attachments'

Account Related Tables

Filter account comments by department (requires AccountId):

SELECT * FROM AccountComments WHERE AccountId = 'acc123'

Filter account history (requires AccountId):

SELECT * FROM AccountHistory WHERE AccountId = 'acc123'

Contact Related Tables

Filter contact comments (requires ContactId):

SELECT * FROM ContactComments WHERE ContactId = 'contact123'

Filter contact history by agent:

SELECT * FROM ContactHistory WHERE AgentId = 'agent789' AND ContactId = '1234'

Article Related Tables

Filter articles by author:

SELECT * FROM Articles WHERE AuthorId = '963741'

Filter article feedbacks by locale:

SELECT * FROM ArticleFeedbacks WHERE Locale = 'en-US'

Community Tables

Filter community category by department:

SELECT * FROM CommunityCategory WHERE Departmentid = '1234'

Filter community topic comments (requires TopicId):

SELECT * FROM CommunityTopicComments WHERE TopicId = 'topic123' AND EndTime = '2024-01-31T23:59:59.000'

Badge and Credit Management

Filter badges by type:

SELECT * FROM Badges WHERE FilterType = 'ACHIEVEMENT'

Filter credits by type:

SELECT * FROM Credits WHERE FilterType = 'ACHIEVEMENT'

Customer Happiness

Filter customer happiness content by thread:

SELECT * FROM CustomerHappinessContent WHERE ThreadId = '1234'

Filter customer happiness link holder by Languagecode:

SELECT * FROM CustomerHappinessLinkHolder WHERE LanguageCode = 'en'

Import and Export

Filter BulkExport (requires ExportId):

SELECT * FROM BulkExport WHERE ExportId = 'export123'

Filter Imports (requires Id):

SELECT * FROM Imports WHERE Id = 'import123'

Instant Messaging

Filter IM sessions by channel:

SELECT * FROM IMSessions WHERE ChannelId = 'chat001'

Filter IM channels by department:

SELECT * FROM IMChannels WHERE DepartmentId = '159753'

Help Centers

List help centers:

SELECT * FROM HelpCenters

Filter contact help centers (requires ContactId):

SELECT * FROM ContactHelpCenters WHERE ContactId = 'contact123' AND HelpCenterId = 'help001'

Data Sharing and Security

List data sharing rules:

SELECT * FROM DataSharingRules

Filter recycle bin by department:

SELECT * FROM RecycleBin WHERE DepartmentId = '951357'

Email and Notifications

Filter email failure alerts by department:

SELECT * FROM EmailFailureAlerts WHERE DepartmentId = '456789'

Filter mail reply address by department:

SELECT * FROM MailReplyAddress WHERE DepartmentId = '789456'

Templates and Forms

Filter templates by department:

SELECT * FROM Templates WHERE DepartmentId = '123987'

Filter template folders by department:

SELECT * FROM TemplateFolders WHERE DepartmentId = '987321'

Search Tables

Filter tag search by department:

SELECT * FROM TagSearch WHERE DepartmentId = '159357'

Search products by name:

SELECT * FROM ProductSearch WHERE ProductName = 'Support Plan'

SLA and Statistics

Filter account SLA (requires AccountId):

SELECT * FROM AccountSla WHERE AccountId = 'acc123' AND DepartmentId = '753159'

Filter account statistics (requires AccountId):

SELECT * FROM AccountStatistics WHERE AccountId = 'acc123' AND DepartmentId = '951753'

Ticket Associations

Filter associated tickets by assignee:

SELECT * FROM AssociatedTickets WHERE FilterAssignee = 'agent999'

Filter bug tickets by bug:

SELECT * FROM BugTickets WHERE BugId = '357951'

Department Management

Filter department by IDs:

SELECT * FROM DepartmentByIds WHERE Id = '123456'

Filter DepartmentTeams (requires DepartmentId):

SELECT * FROM DepartmentTeams WHERE DepartmentId = '654987'

Thread and Conversations

Filter ThreadOriginalContent (requires ThreadId, TicketId):

SELECT * FROM ThreadOriginalContent WHERE ThreadId = 'thread123' AND TicketId = 'ticket456'

Filter ticket conversations (requires TicketId):

SELECT * FROM TicketConversations WHERE TicketId = '12345'

Custom Fields and Modules

Filter custom field count by department:

SELECT * FROM CustomFieldCount WHERE DepartmentId = '321987'

List modules :

SELECT * FROM MyModules

Filter automation feature count by feature:

SELECT * FROM AutomationFeatureCount WHERE Feature = 'workflows'

Dependencies and Mappings

Filter available dependency mappings by layout:

SELECT * FROM AvailableDependencyMappings WHERE LayoutId = 'layout456'

Filter dependency mappings by layout:

SELECT * FROM DependencyMappings WHERE LayoutId = 'layout789'

My Preferences and Profile

Filter my preferences by department:

SELECT * FROM MyPreferences WHERE DepartmentId = '147963'

List my profile permissions:

SELECT * FROM MyProfilePermissions

Agent Management Extended

Filter agent by IDs:

SELECT * FROM AgentByIds WHERE Id = 'agent147'

Filter agent signatures (requires AgentId):

SELECT * FROM AgentSignatures WHERE AgentId = 'agent123'

Contact Extended Operations

Filter contact by IDs:

SELECT * FROM ContactByIds WHERE Id = 'contact789'

Filter ContactProfiles (requires ContactId):

SELECT * FROM ContactProfiles WHERE ContactId = 'contact123'

Timezone and Language

List timezones:

SELECT * FROM TimeZones

List languages:

SELECT * FROM Languages

Location and Geography

List countries:

SELECT * FROM Countries

Filter supported email addresses by department:

SELECT * FROM SupportedEmailAddress WHERE DepartmentId = '357963'

Organization Fields and Permissions

Filter organization fields by department:

SELECT * FROM OrganizationFields WHERE DepartmentId = '741951'

List organization modules:

SELECT * FROM OrganizationModules

Layout Management

Filter LayoutProfiles (requires LayoutId):

SELECT * FROM LayoutProfiles WHERE LayoutId = 'layout123'

Filter layout rules by layout:

SELECT * FROM LayoutRules WHERE LayoutId = 'layout123'

Skill Configuration

Filter skill configuration by department:

SELECT * FROM SkillConfiguration WHERE DepartmentId = '369159'

Filter skill types by department:

SELECT * FROM SkillTypes WHERE DepartmentId = '147753'

Time Tracking Extended

Filter time track history by department:

SELECT * FROM TimeTrackHistory WHERE DepartmentId = '951147'

Filter time track settings by department:

SELECT * FROM TimeTrackSettings WHERE DepartmentId = '753369'

Followers and Users

Filter followers by userType:

SELECT * FROM Followers WHERE UserType = 'END_USERS'

Filter users by HelpCenterId:

SELECT * FROM Users WHERE HelpCenterId = '159951'

Account Extended Tables

Filter account contracts (requires AccountId):

SELECT * FROM AccountContracts WHERE AccountId = 'acc123' AND DepartmentId = '741159'

Filter account followers (requires AccountId):

SELECT * FROM AccountFollowers WHERE AccountId = 'acc123'

Ticket Extended Operations

Filter TicketTasks (requires TicketId):

SELECT * FROM TicketTasks WHERE TicketId = 'ticket123'

Filter ticket pins (requires TicketId):

SELECT * FROM TicketPins WHERE TicketId = '12345'

Filter search by department:

SELECT * FROM Search WHERE DepartmentId = '951741'

Invoice Integration

List invoice tickets:

SELECT * FROM InvoiceTickets

Filter ZohoFinanceEstimates (requires Financeservice):

SELECT * FROM ZohoFinanceEstimates WHERE Financeservice = 'books'

Jira Integration

Filter Jira issue tickets by issue:

SELECT * FROM JiraIssueTickets WHERE IssueId = '147369'

Filter ZohoFinanceInvoices (requires FinanceService):

SELECT * FROM ZohoFinanceInvoices WHERE FinanceService = 'books' AND DepartmentId = '951357'

Metrics and Analytics

Filter metrics agents by department:

SELECT * FROM MetricsAgents WHERE DepartmentId = '741963'

Filter IMMetricSessionTimeSeries (requires Dimension, DimensionValue, Duration, Granularity):

SELECT * FROM IMMetricSessionTimeSeries WHERE Dimension = 'agent' AND DimensionValue = 'agent123' AND Duration = 'LAST_7_DAYS' AND Granularity = 'DAILY'

Additional Search Tables

Filter call search by priority:

SELECT * FROM CallSearch WHERE Priority = 'High'

Filter event search by status:

SELECT * FROM EventSearch WHERE Status = 'Scheduled'

De-duplication Tables

List account de-duplication field names:

SELECT * FROM AccountDeDuplicationDefaultFieldName

List contact de-duplication field names:

SELECT * FROM ContactDeDuplicationDefaultFieldName

Support Plans and Levels

Filter support plans by department:

SELECT * FROM SupportPlans WHERE DepartmentId = '951147'

List levels:

SELECT * FROM Levels

Agent Profile Management

List light agent profile:

SELECT * FROM LightAgentProfile

List personal role :

SELECT * FROM PersonalRole

Routing and Preferences

Filter routing preferences by department:

SELECT * FROM RoutingPreferences WHERE DepartmentId = '159741'

List community preferences :

SELECT * FROM CommunityPreferences

Specialized Views and Analytics

Filter starred views by department:

SELECT * FROM StarredViews WHERE DepartmentId = '951369'

Filter last accessed view by department:

SELECT * FROM LastAccessedView WHERE DepartmentId = '357147'

Permalink and URL Management

Filter permalink availability by permalink:

SELECT * FROM PermalinkAvailability WHERE Permalink = 'custom-section'

Filter community topic permalinks (requires TopicId):

SELECT * FROM CommunityTopicPermalinks WHERE TopicId = 'topic123'

Subject Access and Compliance

List subject access requests :

SELECT * FROM SubjectAccessRequests

List subject access request fields :

SELECT * FROM SubjectAccessRequestFieldsAndConditions

Community Moderation

List community moderated topics :

SELECT * FROM CommunityModeratedTopics

List community moderated users:

SELECT * FROM CommunityModeratedUsers

Offline and Online Agents

Filter offline agents by department:

SELECT * FROM OfflineAgents WHERE DepartmentId = '753951'

Filter online agents by department:

SELECT * FROM OnlineAgents WHERE DepartmentId = '357741'

Accessible Organizations

List accessible organizations :

SELECT * FROM AccessibleOrganizations

List organizations :

SELECT * FROM Organizations

Agent Tickets and Statistics

Filter agent tickets count by department:

SELECT * FROM AgentTicketsCount WHERE DepartmentId = 'dept123'

List agent availability configuration :

SELECT * FROM AgentAvailabilityConfiguration

Contact and Account Products

Filter account products (requires AccountId):

SELECT * FROM AccountProducts WHERE AccountId = 'acc123' AND DepartmentId = '789123'

Filter contact products (requires ContactId):

SELECT * FROM ContactProducts WHERE ContactId = 'contact123' AND DepartmentId = '123456'

Time Entry Summation Tables

Filter account time entry summation (requires AccountId):

SELECT * FROM AccountTimeEntrySummation WHERE AccountId = 'acc123' AND BillStatus = 'BILLABLE'

Filter agent time entry summation (requires AgentId):

SELECT * FROM AgentTimeEntrySummation WHERE AgentId = 'agent123' AND Module = 'tickets'

All Timers Management

Filter all active timers (requires DepartmentId):

SELECT * FROM AllActiveTimers WHERE DepartmentId = '123456' AND StartTime = '2024-01-15T09:00:00.000'

Filter Timer (requires Module, ModuleId):

SELECT * FROM Timer WHERE Module = 'Tickets' AND ModuleId = '123456'

Article Management Extended

Filter article comments (requires ArticleId, Locale):

SELECT * FROM ArticleComments WHERE ArticleId = 'article123' AND Locale = 'en_US' AND Include = 'attachments'

Filter article history (requires ArticleId):

SELECT * FROM ArticleHistory WHERE ArticleId = 'article123'

Article Insights and Translation

Filter article insights (requires ArticleId):

SELECT * FROM ArticleInsights WHERE ArticleId = 'article123'

Filter article translations (requires ArticleId):

SELECT * FROM ArticleTranslations WHERE ArticleId = 'article123' AND Locale = 'en-US'

Badge Management Extended

List available badge icons:

SELECT * FROM AvailableBadgeIcons

Filter BadgeUsers (requires BadgeId):

SELECT * FROM BadgeUsers WHERE BadgeId = 'badge123'

Business Rules and Hours

Filter BusinessHourRelatedRules (requires BusinessHourId):

SELECT * FROM BusinessHourRelatedRules WHERE BusinessHourId = 'bh123'

Filter skill related rules by skills:

SELECT * FROM SkillRelatedRules WHERE SkillId = '258741'

Call Management Extended

Filter CallComments (requires CallId):

SELECT * FROM CallComments WHERE CallId = 'call123' AND Include = 'attachments'

Filter ticket calls (requires TicketId):

SELECT * FROM TicketCalls WHERE TicketId = '12345'

Comment History and Tracking

List comment history (required TicketId an CommentId) :

SELECT * FROM CommentHistory WHERE TicketId = '357951' AND CommentId = '1234'

Filter community moderation comments by status:

SELECT * FROM CommunityModerationComments WHERE Status = 'active'

Community Category Management

Filter community category by permalink:

SELECT * FROM CommunityCategoryByPermalink WHERE Permalink = 'support-discussion'

Filter community category followers by category:

SELECT * FROM CommunityCategoryFollowers WHERE CategoryId = 'cat123'

Community Moderation Extended

Filter community moderation counts by category:

SELECT * FROM CommunityModerationCounts WHERE CategoryId = '753159'

Filter community moderation topics by status:

SELECT * FROM CommunityModerationTopics WHERE Status = 'active'

Community User Management

Filter community my drafted topics by type:

SELECT * FROM CommunityMyDraftedTopics WHERE Type = 'Question'

Filter community user comments (requires UserId):

SELECT * FROM CommunityUserComments WHERE UserId = 'user123' AND EndTime = '2024-01-31T23:59:59.000'

Contact Statistics and Tickets

Filter contact statistics (requires ContactId):

SELECT * FROM ContactStatistics WHERE ContactId = 'contact123' AND DepartmentId = '951357'

Filter contact tickets by department:

SELECT * FROM ContactTickets WHERE DepartmentId = '357159'

Credit Management Extended

Filter credit users by creditId:

SELECT * FROM CreditUsers WHERE CreditId = '159357'

Dashboard Extended Analytics

Filter DashboardTickets (requires Duration, GroupBy, TicketType):

SELECT * FROM DashboardTickets WHERE Duration = 'LAST_30_DAYS' AND GroupBy = 'status' AND TicketType = 'INCIDENT' AND DepartmentId = '741963'

Filter DashboardTicketsResolutionTime (requires Duration, GroupBy):

SELECT * FROM DashboardTicketsResolutionTime WHERE Duration = 'LAST_14_DAYS' AND GroupBy = 'agent' AND Channel = 'Email'

Department Extended Management

Filter department check exists by department:

SELECT * FROM DepartmentCheckExists WHERE DepartmentName = 'testname'

Filter department mail configurations by department:

SELECT * FROM DepartmentMailConfigurations WHERE DepartmentId = '654987'

Account Tickets and Time Entry

Filter account tickets (requires AccountId):

SELECT * FROM AccountTickets WHERE AccountId = 'acc123' AND DepartmentId = '789321'

Filter contact time entry by bill status:

SELECT * FROM ContactTimeEntry WHERE FilterBillStatus = 'NON_BILLABLE'

Contact Time Entry Summation

Filter contact time entry summation (requires ContactId):

SELECT * FROM ContactTimeEntrySummation WHERE ContactId = 'contact123' AND FetchModule = 'events'

Filter task time entry (requires TaskId):

SELECT * FROM TaskTimeEntry WHERE TaskId = 'task123'

Task Management Extended

Filter task time entry summation (requires TaskId):

SELECT * FROM TaskTimeEntrySummation WHERE TaskId = 'task123' AND FilterBillStatus = 'BILLABLE'

Filter tasks by department:

SELECT * FROM Tasks WHERE DepartmentId = '123789'

Community Topic Management

Filter CommunityTopicCommentById (requires Id, TopicId):

SELECT * FROM CommunityTopicCommentById WHERE Id = 'comment123' AND TopicId = 'topic456'

List community topic types:

SELECT * FROM CommunityTopicTypes

Community Users and Followers

Filter community user followers (requires UserId):

SELECT * FROM CommunityUserFollowers WHERE UserId = 'user123'

Filter community user topics (requires UserId):

SELECT * FROM CommunityUserTopics WHERE UserId = 'user123' AND Type = 'CONTRIBUTOR'

Community Follower Management

Filter CommunityTopicFollowerParticipantVoter (requires TopicId, TopicType):

SELECT * FROM CommunityTopicFollowerParticipantVoter WHERE TopicId = 'topic123' AND FilterTopicType = 'QUESTION'

Filter contact followers (requires ContactId):

SELECT * FROM ContactFollowers WHERE ContactId = 'contact123'

Template Management Extended

Filter template placeholders by department:

SELECT * FROM TemplatePlaceholders WHERE DepartmentId = '321987'

Filter ticket templates by department:

SELECT * FROM TicketTemplates WHERE DepartmentId = '987654'

Ticket Extended Operations

Filter ticket approvals (requires TicketId):

SELECT * FROM TicketApprovals WHERE TicketId = '12345'

Filter ticket article suggestion (requires TicketId):

SELECT * FROM TicketArticleSuggestion WHERE TicketId = '12345' AND DepartmentId = '741963'

Ticket Blueprint and Resolution

Filter ticket blueprint (requires TicketId):

SELECT * FROM TicketBlueprint WHERE TicketId = '12345'

Filter TicketResolution (requires TicketId):

SELECT * FROM TicketResolution WHERE TicketId = 'ticket123'

Ticket Resolution and History

Filter TicketResolutionHistory (requires TicketId):

SELECT * FROM TicketResolutionHistory WHERE TicketId = 'ticket123'

Filter ticket transition form (requires TicketId, TransitionId):

SELECT * FROM TicketTransitionForm WHERE TicketId = '12345' AND TransitionId = 'trans123'

Time Entry Extended Tables

Filter ticket time entry (requires TicketId):

SELECT * FROM TicketTimeEntry WHERE TicketId = '12345'

Filter ticket time entry by billing type (requires TicketId):

SELECT * FROM TicketTimeEntryByBillingType WHERE TicketId = '12345'

Ticket Time Entry Summation

Filter ticket time entry summation by module:

SELECT * FROM TicketTimeEntrySummation WHERE FetchModule = 'tasks'

Filter ticket count by field values:

SELECT * FROM TicketCountByFieldValues WHERE FilterField = 'status'

Translation Management Extended

Filter translation feedbacks (requires ArticleId, Locale):

SELECT * FROM TranslationFeedbacks WHERE ArticleId = 'article123' AND Locale = 'en_US'

Filter translation permalinks (requires ArticleId, Locale):

SELECT * FROM TranslationPermalinks WHERE ArticleId = 'article123' AND Locale = 'en_US'

User Management Extended

Filter user badges (requires UserId):

SELECT * FROM UserBadges WHERE UserId = 'user123'

Filter user groups by search:

SELECT * FROM UserGroups WHERE SearchKeyword = 'name'

User Labels and Groups

Filter user labels (requires UserId):

SELECT * FROM UserLabels WHERE UserId = 'user123'

Filter label users by search:

SELECT * FROM LabelUsers WHERE SearchKeyword = 'name'

Validation and Layout Rules

Filter ValidationRuleCriteriaFields (requires LayoutId):

SELECT * FROM ValidationRuleCriteriaFields WHERE LayoutId = 'layout456'

Filter LayoutRuleCriteriaFields (requires LayoutId):

SELECT * FROM LayoutRuleCriteriaFields WHERE LayoutId = 'layout789'

Filter standard layout format by module:

SELECT * FROM StandardLayoutFormat WHERE FetchModule = 'tickets'

Skill and Criteria Management

Filter skill criteria fields by department:

SELECT * FROM SkillCriteriaFields WHERE DepartmentId = '357159'

Filter skills by department:

SELECT * FROM Skills WHERE DepartmentId = '741852'

Team Management Extended

Filter TeamAssociables (requires TeamId):

SELECT * FROM TeamAssociables WHERE TeamId = 'team123'

Filter agent teams by agent:

SELECT * FROM AgentTeams WHERE AgentId = '258741'

Role Management Extended

Filter role by IDs:

SELECT * FROM RoleByIds WHERE Id = 'role456'

Filter role agents by role:

SELECT * FROM RoleAgents WHERE RoleId = '963147'

Role Teams and Profile Management

Filter role teams by role:

SELECT * FROM RoleTeams WHERE RoleId = '147963'

Filter profile agents by profile:

SELECT * FROM ProfileAgents WHERE ProfileId = '753159'

Organization Field Management

Filter organization field criteria references by field :

SELECT * FROM OrganizationFieldCriteriaReferences WHERE FieldId = '1234' AND FilterFeatureType = 'featuretype'

Filter OrganizationFieldPermissions (requires FieldId):

SELECT * FROM OrganizationFieldPermissions WHERE FieldId = 'field123'

Support Email and Domain

List support email domain :

SELECT * FROM SupportEmailDomain

Filter VoterTrend (requires TopicId):

SELECT * FROM VoterTrend WHERE TopicId = 'topic123'

IM Canned Messages and Channels

Filter IM canned messages by department:

SELECT * FROM IMCannedMessages WHERE DepartmentId = '741159'

Filter ArchivedTickets (requires DepartmentId):

SELECT * FROM ArchivedTickets WHERE DepartmentId = '963753'

KB Root Categories Management

Filter KB root categories category tree by id:

SELECT * FROM KbRootCategoriesCategoryTree WHERE Id = '123'

Filter KB root categories review owners by RootCategoryId:

SELECT * FROM KbRootCategoriesReviewOwners WHERE RootCategoryId = '1234'

KB Category Management

Filter KB category reposition articles by category:

SELECT * FROM KbCategoryRepositionArticles WHERE CategoryId = 'cat789'

Filter my form by layout:

SELECT * FROM MyForm WHERE LayoutId = '159741'

My Information and Approvals

Filter my pending approvals by department:

SELECT * FROM MyPendingApprovals WHERE DepartmentId = '753357'

List my profile :

SELECT * FROM MyProfile

My Information Extended

List my info:

SELECT * FROM Myinfo

Filter ticket events (requires TicketId):

SELECT * FROM TicketEvents WHERE TicketId = '12345'

Ticket Followers and Tags

Filter ticket followers (requires TicketId):

SELECT * FROM TicketFollowers WHERE TicketId = '12345'

Filter tag tickets by tag:

SELECT * FROM TagTickets WHERE TagId = '963147'

Task Comments and Search

Filter task comments (requires TaskId):

SELECT * FROM TaskComments WHERE TaskId = 'task123'

Group Management Extended

Filter duplicate accounts details by field name and value:

SELECT * FROM DuplicateAccountDetails WHERE FieldValue = '741953' AND FieldName = 'test'

Filter duplicate contacts details by field name and value:

SELECT * FROM DuplicateContactDetails WHERE FieldValue = '741953' AND FieldName = 'test'

Group Users and Duplicates

Filter GroupUsers (requires GroupId):

SELECT * FROM GroupUsers WHERE GroupId = 'group123' AND SearchKeyword = 'email'

Filter GroupDuplicateValues (requires EntityType):

SELECT * FROM GroupDuplicateValues WHERE EntityType = 'contacts' AND FilterFieldName = 'email'

Product Search Management

Filter product search duplicates by product name:

SELECT * FROM ProductSearchDuplicates WHERE ProductName = 'Premium Support'

Filter product tickets (requires ProductId):

SELECT * FROM ProductTickets WHERE ProductId = 'prod123' AND DepartmentId = '753951'

Filter account contacts (requires AccountId):

SELECT * FROM AccountContacts WHERE AccountId = 'acc123'

Search article translations by author:

SELECT * FROM ArticleTranslationSearch WHERE AuthorId = 'author123'

Search article translations by category:

SELECT * FROM ArticleTranslationSearch WHERE CategoryId = 'cat456'

Search article translation by tag and author:

SELECT * FROM ArticleTranslationSearchByTag WHERE AuthorId = 'author789'

Filter departments by enabled status:

SELECT * FROM Departments WHERE IsEnabled = 'true'

Filter event comments with include parameter:

SELECT * FROM EventComments WHERE Include = 'eventDetails'

Filter product contacts (requires ProductId):

SELECT * FROM ProductContacts WHERE ProductId = 'prod123' AND IsSpam = 'false'

Filter products by owner:

SELECT * FROM Products WHERE OwnerId = 'owner456'

Filter products by department:

SELECT * FROM Products WHERE DepartmentIds = '123456'

Filter tickets by status:

SELECT * FROM Tickets WHERE Status = 'Open'

Filter tickets by priority:

SELECT * FROM Tickets WHERE Priority = 'HIGH'

Filter ticket history by event type (requires TicketId):

SELECT * FROM TicketHistory WHERE TicketId = '12345' AND EventFilter = 'COMMENT'

Filter ticket history by agent (requires TicketId):

SELECT * FROM TicketHistory WHERE TicketId = '12345' AND AgentId = 'agent789'

Filter ticket latest thread with public visibility (requires TicketId):

SELECT * FROM TicketLatestThread WHERE TicketId = '12345' AND NeedPublic = 'true'

Filter ticket threads by ticket (requires TicketId):

SELECT * FROM TicketThreads WHERE TicketId = '12345'

Filter customer happiness by account (requires DepartmentId):

SELECT * FROM CustomerHappiness WHERE DepartmentId = '123456' AND AccountId = 'acc123'

Filter customer happiness by contact (requires DepartmentId):

SELECT * FROM CustomerHappiness WHERE DepartmentId = '123456' AND ContactId = 'contact456'

Get ticket metrics (requires TicketId):

SELECT * FROM TicketMetrics WHERE TicketId = '12345'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are None or OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
Domain	Determines the domain where authentication calls will be sent to. Allowed values are: MIXPANEL, EU.MIXPANEL, IN.MIXPANEL, COM, EU, COM.AU, IN, .COM
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Organization	The Id associated with the specific Zoho Desk organization you wish to connect to. Get it from Organizations table.
Scope	Scope(s) to use when authenticating, that control access to specific information.