Freshdesk

Learn how to use Freshdesk with Composio

Overview

SLUG: FRESHDESK

Description

Freshdesk provides customer support software with ticketing, knowledge base, and automation features for efficient helpdesk operations and better customer experiences

Authentication Details

subdomain
stringRequired
generic_api_key
stringRequired

Connecting to Freshdesk

Create an auth config

Use the dashboard to create an auth config for the Freshdesk toolkit. This allows you to connect multiple Freshdesk accounts to Composio for agents to use.

1

Select App

Navigate to Freshdesk.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Freshdesk Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4freshdesk_auth_config_id = "ac_YOUR_FRESHDESK_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Freshdesk for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, freshdesk_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Freshdesk toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add Note to Ticket

Description

Tool to add a private or public note to an existing ticket in Freshdesk. Use when you need to add internal comments or public notes to a ticket. Notes can be private (agent-only) or public, and can include HTML content.

Action Parameters

body
stringRequired
notify_emails
array
private
booleanDefaults to True
ticket_id
integerRequired
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Ticket User Access

Description

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. The endpoint accepts agent IDs (not contact IDs) and returns the list of agent IDs that have access to the ticket.

Action Parameters

ticket_id
integerRequired
user_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Watcher to Ticket

Description

Tool to add the authenticated user as a watcher to a Freshdesk ticket. Use when you need to follow a ticket's progress and receive email notifications for updates like replies or status changes. The API automatically uses the authenticated user's credentials and does not require additional parameters.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel Contact Import

Description

Tool to cancel an ongoing contact import operation in Freshdesk. Use when you need to halt a contact import process that is currently running.

Action Parameters

import_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Admin Group

Description

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 assignment configuration.

Action Parameters

agent_ids
array
allow_agents_to_change_availability
boolean
automatic_agent_assignment
object
business_calendar_id
integer
description
string
escalate_to
integer
name
stringRequired
type
stringDefaults to support_agent_group
unassigned_for
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Multiple Agents

Description

Tool to create multiple agents in Freshdesk in a single bulk operation. Use when you need to add multiple agents at once. This is an asynchronous operation that returns a job_id for tracking the creation status.

Action Parameters

agents
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Company

Description

Tool to create a new company in Freshdesk. Use when you need to add a customer organization to your Freshdesk account. Companies can hold multiple contacts and are automatically associated with contacts based on email domain matching.

Action Parameters

account_tier
string
custom_fields
object
description
string
domains
array
health_score
string
industry
string
name
stringRequired
note
string
phone
string
renewal_date
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Contact Field

Description

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., job title, department, customer type). The field type can be text, number, dropdown, checkbox, date, or paragraph.

Action Parameters

choices
array
customers_can_edit
boolean
displayed_for_customers
boolean
label
stringRequired
label_for_customers
stringRequired
position
integer
required_for_agents
boolean
required_for_customers
boolean
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Discussion Category

Description

Tool to create a new discussion category in Freshdesk forums.

Action Parameters

description
stringRequired
name
stringRequired
position
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Email Mailbox

Description

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. Requires valid product_id and group_id.

Action Parameters

default_reply_email
boolean
group_id
integerRequired
mailbox_type
stringRequired
name
stringRequired
product_id
integerRequired
support_email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Group

Description

Tool to create a new agent group in Freshdesk. Use when you need to organize agents into teams for better ticket routing and management.

Action Parameters

agent_ids
array
auto_ticket_assign
integer
description
string
escalate_to
integer
name
stringRequired
unassigned_for
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create SLA Policy

Description

Tool to create a new SLA (Service Level Agreement) policy in Freshdesk. Use when you need to establish service level targets for ticket response and resolution times based on priority levels.

Action Parameters

active
booleanDefaults to True
applicable_to
objectRequired
description
string
name
stringRequired
sla_target
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Solution Article

Description

Tool to create a new solution article in a Freshdesk knowledge base folder. Use when you need to add documentation, FAQs, or help content to your knowledge base.

Action Parameters

agent_id
integer
description
stringRequired
folder_id
integerRequired
seo_data
object
status
integerDefaults to 1
tags
array
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Ticket

Description

Creates a new ticket in Freshdesk. REQUIRED FIELDS: - subject and description are always required - At least ONE requester identifier is REQUIRED: requester_id, email, phone, facebook_id, twitter_id, or unique_external_id CONDITIONAL REQUIREMENTS: - If phone is provided without email, name becomes MANDATORY NOTE ON ATTACHMENTS: - attachments field expects multipart/form-data format, not file paths

Action Parameters

attachments
array
cc_emails
array
company_id
integer
custom_fields
object
description
stringRequired
due_by
string
email
string
email_config_id
integer
facebook_id
string
fr_due_by
string
group_id
integer
internal_agent_id
integer
internal_group_id
integer
lookup_parameter
string
name
string
phone
string
priority
integerDefaults to 1
product_id
integer
requester_id
integer
responder_id
integer
source
integerDefaults to 2
status
integerDefaults to 2
subject
stringRequired
tags
array
twitter_id
string
unique_external_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Ticket Form

Description

Tool to create a new ticket form in Freshdesk. Use when you need to create a custom ticket form for organizing support requests.

Action Parameters

description
string
fields
array
portal_ids
array
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Currently Authenticated Agent

Description

Tool to retrieve profile information for the currently authenticated agent. Use when you need to get details about the agent whose API credentials are being used for authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Agent

Description

Tool to permanently delete an agent from Freshdesk. Use when you need to remove an agent from your Freshdesk account. Note: You cannot delete yourself. The API prevents self-deletion as a security measure.

Action Parameters

agent_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Automation Rule

Description

Tool to permanently delete an automation rule from Freshdesk. Use when you need to remove a specific automation rule. Note: This action is irreversible and will permanently delete the automation rule. The endpoint returns 204 No Content on success.

Action Parameters

automation_type_id
stringRequired
rule_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Company

Description

Tool to permanently disband a company from Freshdesk. Use when you need to delete a company from your Freshdesk account. Note: Deleting a company only disbands it and does not delete the customers inside it. Once disbanded, the company cannot be restored.

Action Parameters

company_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Company Field

Description

Tool to permanently delete a custom company field from Freshdesk. Use when you need to remove a company field that is no longer needed. Note: This action is irreversible and will delete all data stored in that field across all companies. Only custom fields can be deleted, not default fields.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact

Description

Tool to soft delete a contact from Freshdesk. Use when you need to move a contact from All Contacts to Deleted Contacts view. Future communications from the contact will be directed to SPAM. The contact can be restored later - for permanent deletion, use hard_delete_contact instead.

Action Parameters

contact_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact Field

Description

Tool to permanently delete a custom contact field from Freshdesk. Use when you need to remove a contact field that is no longer needed. Note: This action is irreversible and will delete all data stored in that field across all contacts. Only custom fields can be deleted, not default fields.

Action Parameters

contact_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Conversation

Description

Tool to permanently delete a conversation from a ticket in Freshdesk. Use when you need to remove a specific conversation from a ticket. Note: Once deleted, the conversation cannot be restored.

Action Parameters

conversation_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Discussion Category

Description

Tool to permanently delete a forum category in Freshdesk. Use when you need to remove a specific discussion category. Note: Once deleted, the category cannot be restored.

Action Parameters

category_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Discussion Comment

Description

Tool to permanently delete a comment from a discussion in Freshdesk. Use when you need to remove a specific comment from a discussion thread. Note: Once deleted, the comment cannot be restored.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Discussion Forum

Description

Tool to permanently delete a discussion forum in Freshdesk. Use when you need to remove a specific forum. Note: Once deleted, the forum cannot be restored.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unmonitor Forum

Description

Tool to unfollow/unmonitor a discussion forum in Freshdesk. Use when you need to stop monitoring a specific forum. The operation removes the following status for the specified user from the forum.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unmonitor Topic

Description

Tool to unfollow/unmonitor a discussion topic in Freshdesk. Use when you need to stop monitoring a specific topic. The operation removes the following status for the specified user from the topic.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Discussion Topic

Description

Tool to permanently delete a discussion topic in Freshdesk. Use when you need to remove a specific topic from forums. Note: Once deleted, the topic cannot be restored.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Email Mailbox

Description

Tool to permanently delete an email mailbox from Freshdesk. Use when you need to remove an email mailbox configuration. Note: This action is irreversible. Once deleted, emails sent to the mailbox's address will not generate tickets.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Group

Description

Tool to permanently disband a group from Freshdesk. Use when you need to delete a group from your Freshdesk account. Note: Deleting a group only disbands it and does not delete the members of the group. Once disbanded, the group cannot be restored.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Multiple Tickets

Description

Asynchronously deletes multiple tickets in bulk. Returns a job_id to track deletion progress. Deleted tickets are moved to Trash and can be restored within 30 days.

Action Parameters

ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Section

Description

Tool to permanently delete a section from a ticket field in Freshdesk. Use when you need to remove a section that is no longer needed. Note: The section must be empty before deletion. This action is irreversible.

Action Parameters

section_id
integerRequired
ticket_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Skill

Description

Tool to permanently delete a skill from Freshdesk. Use when you need to remove a skill from your Freshdesk account. This operation is permanent and cannot be undone.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Solution Article

Description

Tool to permanently delete a solution article and its translated versions in Freshdesk. Use when you need to remove a solution article that is no longer needed. Note: This operation is irreversible and cannot be undone.

Action Parameters

article_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Solution Category

Description

Tool to permanently delete a solution category and its translated versions in Freshdesk. Use when you need to remove a solution category that is no longer needed. Note: This operation is irreversible and cannot be undone.

Action Parameters

category_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Solution Folder

Description

Tool to permanently delete a solution folder and its translated versions in Freshdesk. Use when you need to remove a solution folder that is no longer needed. Note: This operation is irreversible and cannot be undone.

Action Parameters

folder_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ticket

Description

Tool to permanently delete a ticket from Freshdesk. Use when you need to remove a ticket from your Freshdesk account. Note: Once deleted, the ticket cannot be restored.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ticket Field

Description

Tool to permanently delete a custom ticket field from Freshdesk. Use when you need to remove a ticket field that is no longer needed. Note: This action is irreversible and will delete all data stored in that field across all tickets. Only custom fields can be deleted, not default fields.

Action Parameters

ticket_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ticket Form

Description

Tool to permanently delete a ticket form from Freshdesk. Use when you need to remove a ticket form that is no longer needed. Note: This action is irreversible and once deleted, the ticket form cannot be restored through standard API operations.

Action Parameters

ticket_form_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ticket Form Field

Description

Tool to permanently delete a specific field from a ticket form in Freshdesk. Use when you need to remove a custom field that is no longer needed from a ticket form. Note: This action is irreversible and only custom fields can be deleted, not default fields which are interlinked with system functionalities.

Action Parameters

field_id
integerRequired
form_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ticket Summary

Description

Tool to delete the AI-generated summary of a ticket in Freshdesk. Use when you need to remove a ticket's summary. Note: Once deleted, the summary cannot be restored.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Time Entry

Description

Tool to permanently delete a time entry from Freshdesk. Use when you need to remove a specific time entry. Note: Once deleted, the time entry cannot be restored.

Action Parameters

time_entry_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Export Contacts

Description

Tool to initiate an asynchronous export of contacts from Freshdesk to CSV file. Use when you need to export contact data for backup, sync with external databases, or data analysis. The API returns an export job ID which can be used to retrieve the download URL once processing completes.

Action Parameters

fields
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Account

Description

Tool to view Freshdesk account information. Use when you need to retrieve comprehensive account details including organization information, agent counts, timezone, data center location, plan tier, address, and primary contact information.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Admin Groups

Description

Tool to list all admin groups in Freshdesk. Use when you need to retrieve all admin groups configured in the account, including their members, escalation settings, and automatic assignment configuration.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Agent

Description

Tool to retrieve detailed information about a specific agent by ID. Use when you need to view a particular agent's profile, contact information, availability status, and role assignments.

Action Parameters

agent_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Agents Autocomplete

Description

Tool to search for agents using autocomplete functionality in Freshdesk. Use when you need to quickly find agents by name or email keyword for autocomplete suggestions.

Action Parameters

term
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Business Hours

Description

Tool to retrieve all business hour configurations from Freshdesk. Use when you need to view the complete list of business hours including schedules, time zones, and working hours for each day.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Canned Response Folders

Description

Tool to retrieve all canned response folders from Freshdesk. Use when you need to list available folders for organizing canned responses. Note: Empty folders (folders without canned responses) are not listed in the API response.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Companies

Description

Tool to retrieve all companies from a Freshdesk account with pagination support. Use when you need to list companies representing customer organizations.

Action Parameters

page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Company

Description

Tool to retrieve detailed information about a specific company by ID. Use when you need to view a particular company's details, domains, and custom fields.

Action Parameters

company_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Company Fields

Description

Tool to retrieve all company fields configured in Freshdesk. Use when you need to get the complete list of company field definitions including default fields (name, description, domains, etc.) and custom fields with their metadata.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact

Description

Tool to retrieve detailed information about a specific contact by ID. Use when you need to view a particular contact's profile, contact information, and custom fields.

Action Parameters

contact_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Fields

Description

Tool to retrieve all contact fields configured in Freshdesk. Use when you need to get the complete list of contact field definitions including default fields (name, email, phone, etc.) and custom fields with their metadata.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts

Description

Tool to retrieve all contacts from a Freshdesk account. Use when you need to list contacts, optionally filtered by email, phone, mobile, company, state, or modification date.

Action Parameters

company_id
integer
email
string
mobile
string
page
integer
per_page
integer
phone
string
state
string
updated_since
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Imported Contacts

Description

Tool to retrieve details of all contact import operations in Freshdesk. Use when you need to view import history, check import status, or get information about failed imports.

Action Parameters

status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Role

Description

Tool to retrieve detailed information about a specific role by ID. Use when you need to view a particular role's name, description, default status, and agent type.

Action Parameters

role_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Scenario Automations

Description

Tool to list all scenario-based automations in Freshdesk. Use when you need to retrieve the complete list of scenario automations with their configurations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Solution Category

Description

Tool to retrieve a specific solution category by ID from Freshdesk. Use when you need detailed information about a solution category including its name, description, visibility settings, and icon.

Action Parameters

category_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Solution Folder

Description

Tool to retrieve a specific solution folder by ID from Freshdesk knowledge base. Use when you need detailed information about a single solution folder including its name, description, hierarchy, visibility settings, and associated metadata.

Action Parameters

folder_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Tickets

Description

Retrieves a list of tickets from Freshdesk.

Action Parameters

agent_id
integer
created_since
string
email
string
filter
string
group_id
integer
page
integerDefaults to 1
per_page
integerDefaults to 30
priority
integer
requester_id
integer
sort_by
string
sort_order
string
status
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Hard Delete Contact

Description

Tool to permanently delete a contact from Freshdesk. Use when you need to completely remove a contact's profile, tickets, calls, forum topics, ratings, and notes (useful for GDPR compliance). By default, the contact must be soft-deleted first unless force=true is used. This deletion is irreversible.

Action Parameters

contact_id
integerRequired
force
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Import Contact

Description

Tool to import contacts in bulk from a CSV file to Freshdesk. Use when you need to create multiple contacts at once from a CSV file with field mappings.

Action Parameters

company_name_column_index
integerRequired
email_column_index
integerRequired
file
object
job_title_column_index
integer
name_column_index
integerRequired
rawContent
string
rawFilename
string
rawMimetype
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Ticket Fields

Description

Tool to retrieve all ticket fields configured in Freshdesk. Use when you need to list all ticket fields including both default system fields and custom fields with their metadata.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Agents in a Group

Description

Tool to retrieve all agents associated with a specific group in Freshdesk. Use when you need to get the list of agents assigned to a particular group.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Business Hours

Description

Tool to retrieve all business hours configurations from Freshdesk. Use when you need to view the complete list of business hour policies including working schedules and time zones.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Sections for a Ticket Field

Description

Tool to retrieve all dynamic sections for a specific ticket field in Freshdesk. Use when you need to view all sections associated with a dropdown field that controls dynamic field visibility.

Action Parameters

ticket_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Skills

Description

Tool to retrieve all skills configured in Freshdesk account. Use when you need to get the complete list of skills available for ticket routing and agent assignment.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Ticket Conversations

Description

Tool to retrieve all conversations of a specific ticket in Freshdesk. Use when you need to view all messages, notes, and replies associated with a ticket.

Action Parameters

page
integer
per_page
integer
ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Tickets

Description

Lists all tickets in Freshdesk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Company Fields

Description

Tool to list all company fields configured in Freshdesk. Use when you need to retrieve metadata about company fields including default fields and custom fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Contact Fields

Description

Tool to list all contact fields configured in Freshdesk. Use when you need to retrieve metadata about contact field definitions including default and custom fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Forum Categories

Description

Tool to retrieve all forum categories (discussions) from Freshdesk. Use when you need to list all discussion categories available in the account. Supports pagination via page parameter.

Action Parameters

page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Topics in a Forum

Description

Tool to retrieve all discussion topics within a specified forum in Freshdesk. Use when you need to list topics in a specific forum. Supports pagination and filtering by user participation.

Action Parameters

forum_id
integerRequired
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Email Mailboxes

Description

Tool to retrieve all email mailbox configurations from Freshdesk account. Use when you need to view support email addresses, mailbox settings, or filter mailboxes by product, group, or status.

Action Parameters

active
boolean
group_id
integer
order_by
string
order_type
string
page
integer
per_page
integer
product_id
integer
support_email
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Email Configs

Description

Tool to retrieve all email configurations from Freshdesk account. Use when you need to view the complete list of email configs including associated products, groups, and email addresses.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Forums in Category

Description

Tool to retrieve all forums within a specified category in Freshdesk. Use when you need to list all forums that exist within a specific forum category. Supports pagination via page and per_page parameters.

Action Parameters

category_id
integerRequired
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Groups

Description

Tool to retrieve all agent groups configured in Freshdesk. Use when you need to get the list of groups for ticket assignment and routing purposes.

Action Parameters

page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Monitored Topics

Description

Tool to retrieve all discussion topics that are monitored/followed by a specific user in Freshdesk. Use when you need to list topics a user is following.

Action Parameters

page
integer
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Participated Topics

Description

Tool to retrieve discussion topics that a user has participated in by creating or commenting. Use when you need to list topics where a specific user has been active. Only admins can fetch topics for other users; without user_id, returns authenticated user's topics.

Action Parameters

page
integer
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Products

Description

Tool to retrieve all products configured in Freshdesk account. Use when you need to get the complete list of products available for support and ticket categorization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Roles

Description

Tool to retrieve all roles available in the Freshdesk system with their permissions and details. Use when you need to get the complete list of roles for agents and collaborators.

Action Parameters

page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Satisfaction Ratings

Description

Tool to retrieve all customer satisfaction survey ratings from Freshdesk. Use when you need to view satisfaction ratings, optionally filtered by creation date. By default, only returns results from the previous month unless created_since parameter is specified.

Action Parameters

created_since
string
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Solution Articles

Description

Tool to retrieve all solution articles within a specified folder in Freshdesk. Use when you need to list all articles that exist within a specific solution folder.

Action Parameters

folder_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Solution Folders

Description

Tool to retrieve all folders within a specified solution category in Freshdesk. Use when you need to list all folders that exist within a specific solution category.

Action Parameters

category_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Solution Subfolders

Description

Tool to retrieve all subfolders within a specified parent folder in Freshdesk Solutions. Use when you need to list nested folders within a solution folder.

Action Parameters

folder_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List a Specific Section Details

Description

Tool to retrieve details of a specific section within a ticket field in Freshdesk. Use when you need to view information about a particular dynamic section including its label, associated choices, and contained fields.

Action Parameters

section_id
integerRequired
ticket_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Surveys

Description

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). Note that only one survey can be active at any given time.

Action Parameters

state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Ticket Fields

Description

Tool to list all ticket fields configured in Freshdesk. Use when you need to retrieve metadata about all ticket field definitions including both default and custom fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Ticket Forms

Description

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.

Action Parameters

include
string
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Ticket Satisfaction Ratings

Description

Tool to list all satisfaction ratings of a ticket. Use when you need to retrieve customer feedback and survey responses for a specific ticket.

Action Parameters

page
integer
per_page
integer
ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Time Entries

Description

Tool to retrieve all time entries from Freshdesk with optional filtering by company, agent, execution time range, and billable status. Use when you need to view time logs across tickets with support for pagination.

Action Parameters

agent_id
integer
billable
boolean
company_id
integer
executed_after
string
executed_before
string
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Comments in a Topic

Description

Tool to retrieve all comments from a specific discussion forum topic. Use when you need to list comments for a given topic ID. Returns an array of comment objects with details like author, content, timestamps, and status.

Action Parameters

topic_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Watcher to Multiple Tickets

Description

Tool to add the authenticated user as a watcher to multiple tickets in bulk. Use when you need to watch multiple tickets at once for notifications and updates.

Action Parameters

ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to Ticket

Description

Replies to an existing ticket in Freshdesk.

Action Parameters

attachments
array
bcc_emails
array
body
stringRequired
cc_emails
array
ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to Forward Ticket

Description

Tool to reply to or forward a ticket to external email addresses. Use when you need to send a ticket reply to specific email recipients outside the normal ticket flow.

Action Parameters

bcc_emails
array
body
stringRequired
cc_emails
array
from_email
string
ticket_id
integerRequired
to_emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to Ticket

Description

Tool to create a public reply to an existing support ticket in Freshdesk. Use when an agent needs to respond to a ticket. The reply is sent to the ticket requester and any CC'd recipients. Supports both plain text and HTML content, file attachments, and email distribution control.

Action Parameters

bcc_emails
array
body
stringRequired
cc_emails
array
from_email
string
ticket_id
integerRequired
to_emails
array
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Agents

Description

Tool to search and filter agents in Freshdesk. Use when you need to find agents by email, phone, mobile, or state (fulltime/occasional).

Action Parameters

email
string
mobile
string
page
integer
per_page
integer
phone
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Companies

Description

Tool to search and filter companies in Freshdesk using query strings with custom fields. Use when you need to find companies based on searchable fields like created_at, updated_at, or custom company fields. Note: Standard fields like 'name' are NOT searchable and will cause validation errors.

Action Parameters

page
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Contacts

Description

Tool to search and filter contacts in Freshdesk using query-based search. Use when you need to find contacts based on fields like email, phone, mobile, company_id, or other searchable contact attributes.

Action Parameters

page
integer
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Solution Articles

Description

Tool to search solution articles in Freshdesk knowledge base by keyword. Use when you need to find articles by searching titles and content.

Action Parameters

term
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Automation Rule

Description

Tool to update an existing automation rule in Freshdesk. Use when you need to modify automation rule properties like name, description, active status, conditions, or actions. Supports ticket creation rules (type 1) and time-based triggers (type 3).

Action Parameters

actions
array
active
boolean
automation_type_id
integerRequired
conditions
object
description
string
id
integerRequired
name
string
position
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Canned Response Folder

Description

Tool to update an existing canned response folder in Freshdesk. Use when you need to modify the name or visibility settings of a canned response folder.

Action Parameters

folder_id
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Company

Description

Tool to update an existing company's information in Freshdesk. Use when you need to modify company details, domains, or custom fields.

Action Parameters

account_tier
string
company_id
integerRequired
custom_fields
object
description
string
domains
array
health_score
string
industry
string
name
string
note
string
renewal_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact Field

Description

Tool to update a contact field's configuration in Freshdesk. Use when you need to modify field properties like labels, requirements, or visibility settings for agents and customers.

Action Parameters

contact_field_id
integerRequired
customers_can_edit
boolean
displayed_for_customers
boolean
label
string
label_for_customers
string
required_for_agents
boolean
required_for_customers
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Conversation

Description

Tool to update the content of a conversation note in Freshdesk. Use when you need to modify existing public or private notes. Note: Only public and private notes can be edited, not incoming replies. The 'private' parameter cannot be modified.

Action Parameters

body
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Group

Description

Tool to update an existing group's information in Freshdesk. Use when you need to modify group details such as name, description, assigned agents, or escalation settings.

Action Parameters

agent_ids
array
auto_ticket_assign
integer
description
string
escalate_to
integer
id
integerRequired
name
string
unassigned_for
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update SLA Policy

Description

Tool to update an existing SLA (Service Level Agreement) policy in Freshdesk. Use when you need to modify service level targets, policy settings, or applicability conditions for an SLA policy.

Action Parameters

active
boolean
applicable_to
object
description
string
id
integerRequired
name
string
sla_target
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Solution Article

Description

Tool to update an existing solution article in Freshdesk knowledge base. Use when you need to modify article details such as title, description, status, or tags.

Action Parameters

agent_id
integer
article_id
integerRequired
category_id
integer
description
string
folder_id
integer
seo_data
object
status
integer
tags
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Solution Category

Description

Tool to update an existing solution category in Freshdesk. Use when you need to modify the name or description of a solution category.

Action Parameters

category_id
integerRequired
description
string
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Solution Folder

Description

Tool to update an existing solution folder in Freshdesk knowledge base. Use when you need to modify folder properties such as name, description, visibility settings, or folder hierarchy.

Action Parameters

company_ids
array
company_segment_ids
array
contact_segment_ids
array
description
string
folder_id
integerRequired
language_code
string
name
string
parent_folder_id
integer
visibility
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Solution Article

Description

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. All parameters are optional; only include fields you want to update.

Action Parameters

agent_id
integer
description
string
id
integerRequired
language_code
string
seo_data
object
status
integer
tags
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Ticket

Description

Tool to update an existing ticket in Freshdesk. Use when you need to modify ticket attributes like subject, priority, status, description, or custom fields.

Action Parameters

attachments
array
company_id
integer
custom_fields
object
description
string
due_by
string
email
string
email_config_id
integer
facebook_id
string
fr_due_by
string
group_id
integer
internal_agent_id
integer
internal_group_id
integer
lookup_parameter
string
name
string
parent_id
integer
phone
string
priority
integer
product_id
integer
requester_id
integer
responder_id
integer
source
integer
status
integer
subject
string
tags
array
ticket_id
integerRequired
twitter_id
string
type
string
unique_external_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Ticket Form

Description

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.

Action Parameters

description
string
include
string
ticket_form_id
integerRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Canned Response

Description

Tool to view details of a specific canned response in Freshdesk. Use when you need to retrieve information about a canned response including its title, content, folder location, and attachments.

Action Parameters

canned_response_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Automation Rule

Description

Tool to view details of a specific automation rule in Freshdesk. Use when you need to retrieve comprehensive information about an automation rule including its triggers, conditions, and actions.

Action Parameters

automation_type_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Business Hour

Description

Tool to retrieve a specific business hour configuration from Freshdesk. Use when you need to view detailed information about business hours including working schedule, time zone, and holiday list.

Action Parameters

business_hours_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Company Field

Description

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 its type, position, and choices for dropdown fields.

Action Parameters

company_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Company Field

Description

Tool to retrieve details of a specific company field by its ID. Use when you need to view configuration, metadata, and schema information for a single company field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Contact Field

Description

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 its type, position, and customer/agent requirements.

Action Parameters

contact_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Contact

Description

Tool to view detailed information about a specific contact by ID. Use when you need to retrieve a contact's profile, contact information, and custom fields.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Email Mailbox Settings

Description

Tool to retrieve mailbox settings for the Freshdesk account. Use when you need to view email configuration settings such as threading options, requester creation settings, and agent conversation permissions.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Email Config

Description

Tool to view details of a specific email configuration in Freshdesk. Use when you need to retrieve information about an email config including its associated product, group, and email addresses.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Group

Description

Tool to view details of a specific admin group in Freshdesk. Use when you need to retrieve information about a group including its members, escalation settings, and automatic assignment configuration.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Automatic BCC Emails

Description

Tool to view automatic BCC email addresses configured in Freshdesk. Use when you need to retrieve the list of email addresses that are automatically added as BCC to outgoing emails from the helpdesk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Product

Description

Tool to retrieve detailed information about a specific product by ID. Use when you need to view a particular product's details including name, description, primary email, and default status.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Role

Description

Tool to view detailed information about a specific role by ID. Use when you need to retrieve a particular role's name, description, default status, and agent type.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Helpdesk Settings

Description

Tool to retrieve helpdesk settings from Freshdesk. Use when you need to view language configuration including primary language, supported languages, portal languages, and help widget languages.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Skill

Description

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, rank, associated agents, and routing conditions.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Solution Category

Description

Tool to view a specific solution category by ID in Freshdesk. Use when you need to retrieve detailed information about a single solution category including its name, description, and visibility settings.

Action Parameters

category_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Solution Folder

Description

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 name, description, hierarchy, and visibility settings.

Action Parameters

folder_id
integerRequired
language_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Solution Article

Description

Tool to view a specific solution article by ID in Freshdesk. Use when you need to retrieve detailed information about a single article including its content, metadata, SEO data, and engagement metrics.

Action Parameters

article_id
integerRequired
language_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Ticket

Description

Views an existing ticket in Freshdesk.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View a Ticket Field

Description

Tool to retrieve a single ticket field configuration from Freshdesk. Use when you need to view detailed information about a specific ticket field including its type, position, visibility settings, and validation requirements.

Action Parameters

ticket_field_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired