> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Freshdesk > Freshdesk provides customer support software with ticketing, knowledge base, and automation features for efficient helpdesk operations and better customer experiences Freshdesk provides customer support software with ticketing, knowledge base, and automation features for efficient helpdesk operations and better customer experiences `freshdesk` · **178 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth freshdesk run auth freshdesk --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run freshdesk # common commands run freshdesk --all # every command ``` ```ts theme={"theme":"github-dark"} import { freshdesk } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `add-note-to-ticket` | Tool to add a private or public note to an existing ticket in Freshdesk. | | `create-admin-group` | Tool to create a new admin-level support agent group in Freshdesk. | | `create-agents` | Tool to create multiple agents in Freshdesk in a single bulk operation. | | `create-canned-response` | Tool to create a new canned response in Freshdesk. Use when you need to create a reusable message template that agents can quickly insert into tickets. | | `create-contact` | Tool to create a new contact in Freshdesk. Use when you need to add a customer or user to your Freshdesk account. | | `create-sla-policies` | Tool to create a new SLA (Service Level Agreement) policy in Freshdesk. | | `create-solution-article` | Tool to create a new solution article in a Freshdesk knowledge base folder. | | `create-ticket-outbound-email` | Tool to create a ticket by sending an outbound email to external recipients. | | `currently-authenticated-agent` | Tool to retrieve profile information for the currently authenticated agent. | | `get-account` | Tool to view Freshdesk account information. Use when you need to retrieve comprehensive account details including organization information, agent... | | `get-agent` | Tool to retrieve detailed information about a specific agent by ID. | | `get-agents` | Tool to search for agents using autocomplete functionality in Freshdesk. | | `get-companies` | Tool to retrieve all companies from a Freshdesk account with pagination support. | | `get-company` | Tool to retrieve detailed information about a specific company by ID. | | `get-company-fields` | Tool to retrieve all company fields configured in Freshdesk. | | `get-contact` | Tool to retrieve detailed information about a specific contact by ID. | | `get-contact-fields` | Tool to retrieve all contact fields configured in Freshdesk. | | `get-contacts` | Tool to retrieve all contacts from a Freshdesk account. Use when you need to list contacts, optionally filtered by email, phone, mobile, company... | | `get-search` | Tool to search and filter tickets in Freshdesk using flexible query syntax. | | `list-all-ticket-conversations` | Tool to retrieve all conversations of a specific ticket in Freshdesk. | | `list-solution-articles` | Tool to retrieve all solution articles within a specified folder in Freshdesk. | | `list-solution-categories` | Tool to retrieve all solution categories in Freshdesk. Use when you need to list all available solution categories in the knowledge base. | | `patch-admin-groups-agents` | Tool to add or remove agents in a Freshdesk group. Use when you need to modify the list of agents assigned to a specific group by providing an array of agent IDs. | | `reply-to-forward-ticket` | Tool to reply to or forward a ticket to external email addresses. | | `search-agents` | Tool to search and filter agents in Freshdesk. Use when you need to find agents by email, phone, mobile, or state (fulltime/occasional). | | Tool | What it does | | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-note-to-ticket` | Tool to add a private or public note to an existing ticket in Freshdesk. | | `add-ticket-user-access` | Tool to add agent access to a specific ticket in Freshdesk. Use when you need to grant agent(s) permission to view or interact with a ticket. | | `add-watcher` | Tool to add the authenticated user as a watcher to a Freshdesk ticket. | | `bulk-unwatch-tickets` | Tool to remove the authenticated user as a watcher from multiple Freshdesk tickets in bulk. | | `bulk-update-tickets` | Tool to update multiple tickets simultaneously in bulk. The bulk update operation runs asynchronously in the background, and returns a job\_id to track progress. | | `cancel-contact-import` | Tool to cancel an ongoing contact import operation in Freshdesk. | | `create-admin` | Tool to create a new admin group in Freshdesk. Use when you need to create a new admin group with specific agents, escalation settings, and automatic... | | `create-admin-group` | Tool to create a new admin-level support agent group in Freshdesk. | | `create-admin-ticket-field` | Tool to create a new custom ticket field in Freshdesk. Use when you need to add a new field definition for capturing additional ticket information... | | `create-admin-ticket-field-section` | Tool to create a new section within a ticket field in Freshdesk. | | `create-agents` | Tool to create multiple agents in Freshdesk in a single bulk operation. | | `create-canned-response` | Tool to create a new canned response in Freshdesk. Use when you need to create a reusable message template that agents can quickly insert into tickets. | | `create-canned-response-bulk` | Tool to create multiple canned responses in bulk via asynchronous operation. | | `create-canned-response-folder` | Tool to create a new canned response folder in Freshdesk. Use when you need to organize canned response templates into folders. | | `create-companies` | Tool to create a new company in Freshdesk. Use when you need to add a customer organization to your Freshdesk account. | | `create-contact` | Tool to create a new contact in Freshdesk. Use when you need to add a customer or user to your Freshdesk account. | | `create-contact-fields` | Tool to create a new custom contact field in Freshdesk. Use when you need to add a new field definition for storing custom contact information (e.g... | | `create-discussion-category` | Tool to create a new discussion category in Freshdesk forums. | | `create-discussion-forum-topic` | Tool to create a new topic in a Freshdesk discussion forum. Use when you need to post a new discussion topic or thread in a specific forum. | | `create-discussion-topic-comment` | Tool to create a new comment on a discussion forum topic. Use when you need to add a comment to an existing topic in Freshdesk discussions. | | `create-email` | Tool to create a new email mailbox in Freshdesk. Use when you need to add a support email address that automatically creates tickets from incoming emails. | | `create-forum` | Tool to create a new forum within a category in Freshdesk discussions. | | `create-sla-policies` | Tool to create a new SLA (Service Level Agreement) policy in Freshdesk. | | `create-solution-article` | Tool to create a new solution article in a Freshdesk knowledge base folder. | | `create-solution-category` | Tool to create a new solution category in Freshdesk's knowledge base. | | `create-ticket` | Creates a new ticket in Freshdesk. REQUIRED FIELDS: - subject and description are always required - At least ONE requester identifier is REQUIRED... | | `create-ticket-forms` | Tool to create a new ticket form in Freshdesk. Use when you need to create a custom ticket form for organizing support requests. | | `create-ticket-outbound-email` | Tool to create a ticket by sending an outbound email to external recipients. | | `create-ticket-time-entry` | Tool to create a time entry for a specific ticket in Freshdesk. | | `create-translated-solution-category` | Tool to create a translated version of an existing solution category. | | `currently-authenticated-agent` | Tool to retrieve profile information for the currently authenticated agent. | | `delete-admin-group` | Tool to delete an admin group from Freshdesk. Use when you need to disband an admin group from your Freshdesk account. | | `delete-agent` | Tool to permanently delete an agent from Freshdesk. Use when you need to remove an agent from your Freshdesk account. | | `delete-automation-rule` | Permanently deletes an automation rule from Freshdesk by its type and rule ID. | | `delete-company` | Tool to permanently disband a company from Freshdesk. Use when you need to delete a company from your Freshdesk account. | | `delete-company-field` | Tool to permanently delete a custom company field from Freshdesk. | | `delete-contact` | Tool to soft delete a contact from Freshdesk. Use when you need to move a contact from All Contacts to Deleted Contacts view. | | `delete-contact-field` | Permanently delete a custom contact field from Freshdesk. Use this action when you need to remove a custom contact field that is no longer needed. | | `delete-conversation` | Tool to permanently delete a conversation from a ticket in Freshdesk. | | `delete-discussion-category` | Permanently deletes a forum discussion category from Freshdesk. | | `delete-discussion-comment` | Tool to permanently delete a comment from a discussion in Freshdesk. | | `delete-discussion-forum` | Tool to permanently delete a discussion forum in Freshdesk. Use when you need to remove a specific forum. | | `delete-discussions-forums-follow` | Tool to unfollow/unmonitor a discussion forum in Freshdesk. Use when you need to stop monitoring a specific forum. | | `delete-discussions-topics-follow` | Tool to unfollow/unmonitor a discussion topic in Freshdesk. Use when you need to stop monitoring a specific topic. | | `delete-discussion-topic` | Tool to permanently delete a discussion topic in Freshdesk. Use when you need to remove a specific topic from forums. | | `delete-email-mailboxes` | Tool to permanently delete an email mailbox from Freshdesk. Use when you need to remove an email mailbox configuration. | | `delete-group` | Tool to permanently disband a group from Freshdesk. Use when you need to delete a group from your Freshdesk account. | | `delete-multiple-tickets` | Asynchronously deletes multiple tickets in bulk. Returns a job\_id to track deletion progress. | | `delete-section` | Tool to permanently delete a section from a ticket field in Freshdesk. | | `delete-skill` | Tool to permanently delete a skill from Freshdesk. Use when you need to remove a skill from your Freshdesk account. | | `delete-solution-article` | Tool to permanently delete a solution article and its translated versions in Freshdesk. | | `delete-solution-category` | Permanently delete a solution category from Freshdesk's knowledge base. | | `delete-solution-folder` | Tool to permanently delete a solution folder and its translated versions in Freshdesk. | | `delete-ticket` | Tool to permanently delete a ticket from Freshdesk. Use when you need to remove a ticket from your Freshdesk account. | | `delete-ticket-field` | Permanently delete a custom ticket field from Freshdesk. Use this tool when you need to remove a custom ticket field that is no longer needed. | | `delete-ticket-form` | Tool to permanently delete a ticket form from Freshdesk. Use when you need to remove a ticket form that is no longer needed. | | `delete-ticket-forms` | Tool to permanently delete a specific field from a ticket form in Freshdesk. | | `delete-ticket-summary` | Tool to delete the AI-generated summary of a ticket in Freshdesk. | | `delete-ticket-user-access` | Tool to remove all agent access from a specific ticket in Freshdesk. | | `delete-time-entry` | Tool to permanently delete a time entry from Freshdesk. Use when you need to remove a specific time entry. | | `export-contacts` | Tool to initiate an asynchronous export of contacts from Freshdesk to CSV file. | | `get-account` | Tool to view Freshdesk account information. Use when you need to retrieve comprehensive account details including organization information, agent... | | `get-agent` | Tool to retrieve detailed information about a specific agent by ID. | | `get-agent-availability` | Tool to retrieve availability information for a specific agent. | | `get-agents` | Tool to search for agents using autocomplete functionality in Freshdesk. | | `get-business-hours` | Retrieves all business hours configurations from Freshdesk. Use this tool to get a complete list of all business hour configurations including... | | `get-canned-response-folders` | Tool to retrieve all canned response folders from Freshdesk. | | `get-companies` | Tool to retrieve all companies from a Freshdesk account with pagination support. | | `get-company` | Tool to retrieve detailed information about a specific company by ID. | | `get-company-fields` | Tool to retrieve all company fields configured in Freshdesk. | | `get-contact` | Tool to retrieve detailed information about a specific contact by ID. | | `get-contact-fields` | Tool to retrieve all contact fields configured in Freshdesk. | | `get-contacts` | Tool to retrieve all contacts from a Freshdesk account. Use when you need to list contacts, optionally filtered by email, phone, mobile, company... | | `get-discussion-category` | Tool to view details of a specific forum category in Freshdesk. | | `get-discussion-topic` | Tool to retrieve detailed information about a specific discussion topic by ID. | | `get-email-mailbox` | Tool to retrieve detailed information about a specific email mailbox by ID. | | `get-folder-responses` | Tool to retrieve all canned responses within a specific folder in Freshdesk. | | `get-imported-contacts` | Tool to retrieve details of all contact import operations in Freshdesk. | | `get-job` | Tool to view the status of a bulk job operation. Use when you need to check the status of bulk ticket updates or bulk ticket deletions. | | `get-scenario-automations-json` | Tool to list all scenario-based automations in Freshdesk. Use when you need to retrieve the complete list of scenario automations with their configurations. | | `get-search` | Tool to search and filter tickets in Freshdesk using flexible query syntax. | | `get-tickets` | Retrieves a list of tickets from Freshdesk. Tickets are returned under `response_data` in the response object. | | `get-ticket-time-entries` | Tool to retrieve all time entries for a specific ticket in Freshdesk. | | `get-ticket-user-access` | Tool to retrieve agent access information for a specific ticket in Freshdesk. | | `get-translated-solution-category` | Tool to view a translated solution category in Freshdesk. Use when you need to retrieve a solution category in a specific language other than the default language. | | `hard-delete-contact` | Tool to permanently delete a contact from Freshdesk. Use when you need to completely remove a contact's profile, tickets, calls, forum topics... | | `import-contact` | Tool to import contacts in bulk from a CSV file to Freshdesk. | | `list-admin-groups` | Tool to list all admin groups in Freshdesk. Use when you need to retrieve all groups configured in the account with their members, escalation... | | `list-all-agents-in-group` | Tool to retrieve all agents associated with a specific group in Freshdesk. | | `list-all-sections-for-ticket-field` | Tool to retrieve all dynamic sections for a specific ticket field in Freshdesk. | | `list-all-skills` | Tool to retrieve all skills configured in Freshdesk account. | | `list-all-ticket-conversations` | Tool to retrieve all conversations of a specific ticket in Freshdesk. | | `list-automation-rules` | Tool to list all automation rules for a specific automation type in Freshdesk. | | `list-discussions` | Tool to retrieve all forum categories (discussions) from Freshdesk. | | `list-discussions-topics` | Tool to retrieve all discussion topics within a specified forum in Freshdesk. | | `list-email` | Tool to retrieve all email mailbox configurations from Freshdesk account. | | `list-email-configs` | Retrieve all email configurations from a Freshdesk account. Returns a list of email configs including support email addresses, associated products... | | `list-forums-in-category` | Tool to retrieve all forums within a specified category in Freshdesk. | | `list-monitored-topics` | Tool to retrieve all discussion topics that are monitored/followed by a specific user in Freshdesk. | | `list-participated-topics` | Tool to retrieve discussion topics that a user has participated in by creating or commenting. | | `list-products` | Tool to retrieve all products configured in Freshdesk account. | | `list-roles` | Tool to retrieve all roles available in the Freshdesk system with their permissions and details. | | `list-satisfaction-ratings` | Tool to retrieve all customer satisfaction survey ratings from Freshdesk. | | `list-sla-policies` | Tool to retrieve all SLA (Service Level Agreement) policies in Freshdesk. | | `list-solution-articles` | Tool to retrieve all solution articles within a specified folder in Freshdesk. | | `list-solution-categories` | Tool to retrieve all solution categories in Freshdesk. Use when you need to list all available solution categories in the knowledge base. | | `list-solution-folders` | Tool to retrieve all folders within a specified solution category in Freshdesk. | | `list-solutions-category-folders-translated` | Tool to retrieve all translated solution folders in a category. | | `list-solution-subfolders` | Tool to list all subfolders within a specific solution folder in Freshdesk. | | `list-specific-section-details` | Tool to retrieve details of a specific section within a ticket field in Freshdesk. | | `list-surveys` | Tool to retrieve all surveys from a Freshdesk account. Use when you need to view the list of surveys, optionally filtered by state (active or inactive). | | `list-ticket-fields` | Tool to list all ticket fields configured in Freshdesk. Use when you need to retrieve metadata about all ticket field definitions including both... | | `list-ticket-forms` | Tool to retrieve all ticket forms from Freshdesk. Use when you need to view the list of available ticket forms, optionally with pagination or portal associations. | | `list-ticket-satisfaction-ratings` | Tool to list all satisfaction ratings of a ticket. Use when you need to retrieve customer feedback and survey responses for a specific ticket. | | `list-tickets-watchers` | Tool to list all watchers subscribed to a specific Freshdesk ticket. | | `list-time-entries` | Tool to retrieve all time entries from Freshdesk with optional filtering by company, agent, execution time range, and billable status. | | `list-topic-comments2` | Tool to list all comments on a specific discussion topic with pagination support. | | `list-translated-solution-articles` | Tool to view all translated solution articles in a folder for a specific language. | | `list-translated-subfolders` | Tool to list all translated subfolders within a parent folder in Freshdesk. | | `patch-admin-groups-agents` | Tool to add or remove agents in a Freshdesk group. Use when you need to modify the list of agents assigned to a specific group by providing an array of agent IDs. | | `remove-watcher` | Tool to remove the authenticated user as a watcher from a Freshdesk ticket. | | `reply-to-forward-ticket` | Tool to reply to or forward a ticket to external email addresses. | | `reply-to-ticket` | Tool to create a public reply to an existing support ticket in Freshdesk. | | `search-agents` | Tool to search and filter agents in Freshdesk. Use when you need to find agents by email, phone, mobile, or state (fulltime/occasional). | | `search-companies` | Tool to search and filter companies in Freshdesk using query strings with custom fields. | | `search-company` | Tool to search for companies using autocomplete functionality in Freshdesk. | | `search-contacts` | Tool to search and filter contacts in Freshdesk using query-based search. | | `search-contacts-autocomplete` | Tool to search for contacts using autocomplete functionality in Freshdesk. | | `search-solution-articles` | Tool to search solution articles in Freshdesk knowledge base by keyword. | | `toggle-timer` | Tool to toggle the timer on a time entry to start or stop time tracking. | | `update-admin-group` | Tool to update an existing admin-level support agent group in Freshdesk. | | `update-admin-ticket-field` | Tool to update an existing ticket field configuration in Freshdesk. | | `update-admin-ticket-field-section` | Tool to update a section within a ticket field in Freshdesk. | | `update-agent` | Tool to update an existing agent's information in Freshdesk. | | `update-agent-availability` | Tool to update agent availability settings in Freshdesk. Use when you need to modify an agent's load settings by changing assignment limits for different channels. | | `update-automations` | Tool to update an existing automation rule in Freshdesk. Use when you need to modify automation rule properties like name, description, active... | | `update-canned-response` | Tool to update an existing canned response in Freshdesk. Use when you need to modify the title, content, folder location, visibility, or group access... | | `update-canned-response-folder` | Updates the name of an existing canned response folder in Freshdesk. | | `update-companies` | Tool to update an existing company's information in Freshdesk. | | `update-contact` | Tool to update an existing contact's information in Freshdesk. | | `update-contact-field` | Tool to update a contact field's configuration in Freshdesk. | | `update-contact-make-agent` | Tool to convert a contact into an agent in Freshdesk. Use when you need to grant a contact access to the helpdesk as an agent with specific permissions and roles. | | `update-conversations` | Tool to update the content of a conversation note in Freshdesk. | | `update-discussion-category` | Tool to update an existing discussion category in Freshdesk forums. | | `update-discussion-comment` | Tool to update an existing comment in a discussion forum. Use when you need to edit the content of a comment in Freshdesk discussions. | | `update-discussion-forum` | Tool to update an existing discussion forum in Freshdesk. Use when you need to modify forum details such as name, description, category, type, or visibility settings. | | `update-discussion-topic` | Tool to update an existing discussion topic in Freshdesk. Use when you need to modify a topic's title, message, lock status, or other properties. | | `update-email-settings` | Tool to update mailbox settings for email handling in Freshdesk. | | `update-notification-email-bcc` | Tool to update automatic BCC email addresses for all ticket communications in Freshdesk. | | `update-sla-policies` | Tool to update an existing SLA (Service Level Agreement) policy in Freshdesk. | | `update-solution-category` | Tool to update an existing solution category in Freshdesk. Use when you need to modify the name or description of a solution category. | | `update-solution-folder` | Tool to update an existing solution folder in Freshdesk knowledge base. | | `update-solutions` | Tool to update an existing solution article in Freshdesk. Use when you need to modify the title, description, status, tags, or SEO metadata of a solution article. | | `update-ticket` | Tool to update an existing ticket in Freshdesk. Use when you need to modify ticket attributes like subject, priority, status, description, or custom fields. | | `update-ticket-bulk-watch` | Tool to add the authenticated user as a watcher to multiple tickets in a single bulk operation. | | `update-ticket-forms` | Tool to update an existing ticket form in Freshdesk. Use when you need to modify ticket form properties like title, description, default status, or field configurations. | | `update-ticket-summary` | Tool to update the AI-generated summary of a ticket in Freshdesk. | | `update-ticket-user-access` | Tool to update agent access to a specific ticket in Freshdesk by adding or removing agents. | | `update-time-entry` | Tool to update an existing time entry in Freshdesk. Use when you need to modify time entry details such as duration, notes, billable status, or agent assignment. | | `view-canned-response` | Tool to view details of a specific canned response in Freshdesk. | | `view-automations` | Tool to view details of a specific automation rule in Freshdesk. | | `view-business-hour` | Tool to retrieve a specific business hour configuration from Freshdesk. | | `view-company-field` | Tool to retrieve details of a specific company field by ID. Use when you need to view configuration and metadata for a single company field including... | | `view-contact-field` | Tool to retrieve details of a specific contact field by ID. Use when you need to view configuration and metadata for a single contact field including... | | `view-email` | Tool to retrieve mailbox settings for the Freshdesk account. | | `view-email-configs` | Tool to view details of a specific email configuration in Freshdesk. | | `view-group` | Tool to view details of a specific admin group in Freshdesk. | | `view-notifications` | Tool to view automatic BCC email addresses configured in Freshdesk. | | `view-products` | Tool to retrieve detailed information about a specific product by ID. | | `view-roles` | Tool to view detailed information about a specific role by ID. | | `view-settings` | Tool to retrieve helpdesk settings from Freshdesk. Use when you need to view language configuration including primary language, supported languages... | | `view-skill` | Tool to retrieve a specific skill from Freshdesk by ID. Use when you need to view detailed information about a particular skill including its name... | | `view-solution-category` | Tool to view a specific solution category by ID in Freshdesk. | | `view-solution-folder` | Tool to view a specific solution folder by ID in Freshdesk. Use when you need to retrieve detailed information about a solution folder including its... | | `view-solutions` | Tool to view a specific solution article by ID in Freshdesk. | | `view-ticket` | Views an existing ticket in Freshdesk. Ticket details are returned nested under `response_data` in the tool response. | | `view-ticket-field` | Tool to retrieve a single ticket field configuration from Freshdesk. | | `view-ticket-form-field` | Tool to retrieve a specific field from a ticket form in Freshdesk. | [Open Freshdesk in the console →](https://app.boxd.sh/integrations/detail/freshdesk)