Overview Add Freshdesk to any ModuleX agent or workflow. Customer support helpdesk platform for managing tickets, contacts, agents, and knowledge base articles via the Freshdesk REST API ({domain}.freshdesk.com/api/v2).
Categories : Customer Support · Helpdesk · Productivity & Collaboration · Auth : API Key · Actions : 45
Authentication API Key Authentication Authenticate using your Freshdesk API key and subdomain
Step 1
Log in to your Freshdesk account
Step 2
Click your profile picture in the top right corner
Step 3
Go to Profile Settings
Step 4
Your API key is displayed on the right side of the page
Required Credentials Field Description Required Format Freshdesk Domain Your Freshdesk subdomain (e.g. ‘mycompany’ for mycompany.freshdesk.com) Yes mycompanyFreshdesk API Key Your Freshdesk API key from Profile Settings Yes xXxXxXxXxXxXxXxXxXxX
Available Actions
create_ticket — Create a new support ticket in Freshdesk
Parameters HTML content of the ticket
Email address of the requester
Priority of the ticket: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent) (Default: 1)
Status of the ticket: 2 (Open), 3 (Pending), 4 (Resolved), 5 (Closed) (Default: 2)
ID of the company to associate with the ticket
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateTicketOutput" , "type" : "object" }
get_ticket — Retrieve a specific ticket by its ID
Parameters ID of the ticket to retrieve
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "GetTicketOutput" , "type" : "object" }
update_ticket — Update an existing ticket's properties
Parameters ID of the ticket to update
New subject for the ticket
New HTML content for the ticket
Priority: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent)
Status: 2 (Open), 3 (Pending), 4 (Resolved), 5 (Closed)
ID of the group to assign the ticket to
ID of the agent to assign the ticket to
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "UpdateTicketOutput" , "type" : "object" }
list_all_tickets — List tickets in Freshdesk with optional filtering
Parameters Predefined filter: new_and_my_open, watching, spam, deleted, all_tickets
Filter tickets by requester ID
Filter tickets by requester email
Filter tickets by company ID
Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListAllTicketsOutput" , "type" : "object" }
close_ticket — Close a ticket by setting its status to Closed (5)
Parameters ID of the ticket to close
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CloseTicketOutput" , "type" : "object" }
add_note_to_ticket — Add a private or public note to a ticket
Parameters ID of the ticket to add a note to
Content of the note in HTML format
Whether the note is private (true) or public (false) (Default: true)
List of email addresses to notify about this note
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "AddNoteToTicketOutput" , "type" : "object" }
add_ticket_tags — Add tags to an existing ticket
remove_ticket_tags — Remove tags from an existing ticket
set_ticket_tags — Replace all tags on a ticket with the specified set
set_ticket_priority — Set the priority of a ticket
Parameters Priority: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "SetTicketPriorityOutput" , "type" : "object" }
set_ticket_status — Set the status of a ticket
Parameters Status: 2 (Open), 3 (Pending), 4 (Resolved), 5 (Closed)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "SetTicketStatusOutput" , "type" : "object" }
assign_ticket_to_agent — Assign a ticket to a specific agent
Parameters ID of the agent to assign the ticket to
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "AssignTicketToAgentOutput" , "type" : "object" }
assign_ticket_to_group — Assign a ticket to a specific group
Parameters ID of the group to assign the ticket to
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "AssignTicketToGroupOutput" , "type" : "object" }
create_contact — Create a new contact in Freshdesk
get_contact — Retrieve a contact by their ID
update_contact — Update an existing contact's properties
create_company — Create a new company in Freshdesk
Parameters List of domain names associated with the company (e.g. [‘example.com’])
Description of the company
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateCompanyOutput" , "type" : "object" }
create_agent — Create a new agent in Freshdesk
Parameters Email address of the agent
Ticket permission: 1 (Global Access), 2 (Group Access), 3 (Restricted Access)
Set to true if this is an occasional agent
Type: 1 (Support Agent), 2 (Field Agent), 3 (Collaborator)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateAgentOutput" , "type" : "object" }
update_agent — Update an existing agent's properties
Parameters ID of the agent to update
Ticket permission: 1 (Global Access), 2 (Group Access), 3 (Restricted Access)
Set to true if this is an occasional agent
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "UpdateAgentOutput" , "type" : "object" }
get_agent — Retrieve a single agent by their ID
Parameters ID of the agent to retrieve
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "GetAgentOutput" , "type" : "object" }
list_agents — List all agents in Freshdesk with optional filtering
Parameters Filter agents by email address
Filter by state: fulltime, occasional
Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListAgentsOutput" , "type" : "object" }
create_reply — Create a reply to a ticket
Parameters ID of the ticket to reply to
Content of the reply in HTML format
List of email addresses to CC
List of email addresses to BCC
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateReplyOutput" , "type" : "object" }
forward_ticket — Forward a ticket to an external email address
Parameters ID of the ticket to forward
Content of the forward in HTML format
List of email addresses to forward to
List of email addresses to CC
List of email addresses to BCC
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "ForwardTicketOutput" , "type" : "object" }
reply_to_forward — Reply to a previously forwarded ticket email
Parameters Content of the reply in HTML format
List of email addresses to reply to
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "ReplyToForwardOutput" , "type" : "object" }
create_thread — Create a collaboration thread on a ticket
Parameters ID of the ticket to create the thread for
Type of thread: forward, discussion
ID of the email config to use for the thread
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateThreadOutput" , "type" : "object" }
create_message_for_thread — Create a message in a collaboration thread
Parameters ID of the thread to post the message in
Content of the message in HTML format
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateMessageForThreadOutput" , "type" : "object" }
list_ticket_conversations — List all conversations (notes, replies) for a ticket
Parameters Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListTicketConversationsOutput" , "type" : "object" }
list_ticket_fields — List all ticket fields configured in Freshdesk
create_ticket_field — Create a new custom ticket field
Parameters Display name of the ticket field
Label for the field as seen by customers
Field type: custom_dropdown, custom_checkbox, custom_text, custom_paragraph, custom_number, custom_date, custom_decimal, custom_url
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateTicketFieldOutput" , "type" : "object" }
update_ticket_field — Update a custom ticket field
Parameters ID of the ticket field to update
Updated label for customers
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "UpdateTicketFieldOutput" , "type" : "object" }
create_solution_article — Create a knowledge base article in a folder
Parameters ID of the folder to create the article in
HTML content of the article
Status: 1 (Draft), 2 (Published)
List of tags for the article
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "CreateSolutionArticleOutput" , "type" : "object" }
get_solution_article — Retrieve a knowledge base article by its ID
Parameters ID of the article to retrieve
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "GetSolutionArticleOutput" , "type" : "object" }
update_solution_article — Update a knowledge base article
Parameters ID of the article to update
Status: 1 (Draft), 2 (Published)
Updated tags for the article
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "UpdateSolutionArticleOutput" , "type" : "object" }
delete_solution_article — Delete a knowledge base article
Parameters ID of the article to delete
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" } }, "required" : [ "success" ], "title" : "DeleteSolutionArticleOutput" , "type" : "object" }
search_solution_article — Search knowledge base articles by keyword
Parameters Search keyword to find matching articles
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "SearchSolutionArticleOutput" , "type" : "object" }
list_solution_categories — List all knowledge base solution categories
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListSolutionCategoriesOutput" , "type" : "object" }
list_category_folders — List all folders within a solution category
Parameters ID of the solution category
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListCategoryFoldersOutput" , "type" : "object" }
list_folder_articles — List all articles within a solution folder
Parameters ID of the solution folder
Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListFolderArticlesOutput" , "type" : "object" }
list_all_folders — List all canned response folders
Parameters Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListAllFoldersOutput" , "type" : "object" }
list_folder_canned_responses — List all canned responses in a specific folder
Parameters canned_response_folder_id
ID of the canned response folder
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListFolderCannedResponsesOutput" , "type" : "object" }
get_canned_response — Retrieve a specific canned response by ID
Parameters ID of the canned response
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "data" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "GetCannedResponseOutput" , "type" : "object" }
get_folder_canned_responses — Get detailed canned responses from a folder
Parameters canned_response_folder_id
ID of the canned response folder
Maximum number of results to return (Default: 100)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "GetFolderCannedResponsesOutput" , "type" : "object" }
list_companies — List all companies in Freshdesk
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListCompaniesOutput" , "type" : "object" }
list_email_configs — List all email configurations
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListEmailConfigsOutput" , "type" : "object" }
list_roles — List all agent roles
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "items" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Items" , "type" : "array" } }, "required" : [ "success" ], "title" : "ListRolesOutput" , "type" : "object" }
Limits & Quotas
Rate limits : Freshdesk applies per-plan rate limits. Free plans: 50 calls/min. Growth and above: 200-400+ calls/min depending on plan.Pagination : List endpoints return up to 100 results per page by default.Error model : non-2xx responses are caught and returned as success=False + error rather than raising.
Links 
