Freshdesk API Integration Vol.1

These are the list of integration use cases supported by Knit for Freshdesk API as part of the TICKETING category

Clone a Ticket Form

ID: clone_a_ticket_form
Operation: write
Entities: portal, field, ticket form
Summary: The 'Clone a Ticket Form' API allows users to clone an existing ticket form by specifying the form's ID in the path parameters. The API requires an API key for authentication, which should be included in the headers. The response includes details of the cloned ticket form, such as its ID, name, title, creation and update timestamps, and the fields included in the form. Each field contains information like its ID, name, label, type, and various settings related to its visibility and requirements for agents and customers.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Agent

ID: create_agent
Operation:
Entities:
Summary: The 'Create an Agent' API allows you to create a new agent in the system. You can specify various attributes for the agent such as email, name, ticket scope, occasional status, language, group IDs, role IDs, skill IDs, agent type, and focus mode. The API requires the 'Content-Type' header to be set to 'application/json'. The request body must include the 'email', 'ticket_scope', and 'role_ids' fields. The response includes details about the created agent, such as availability, occasional status, ID, ticket scope, signature, group IDs, role IDs, skill IDs, creation and update timestamps, type, contact details, and focus mode status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete A Comment

ID: delete_a_comment
Operation: write
Entities: discussion, comment, api
Summary: The 'Delete A Comment' API allows users to delete a specific comment in a discussion by providing the comment ID in the URL path. The request requires basic authentication using an API key. The API does not require any query parameters or request body. Upon successful deletion, the API returns a 204 No Content HTTP status, indicating that the comment has been successfully deleted and there is no additional content in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Company

ID: delete_a_company
Operation: write
Entities: contact, company
Summary: The 'Delete a Company' API endpoint allows users to delete a company from the system using its unique identifier. The request requires an API key for authentication, which should be included in the headers as 'Authorization'. The company ID must be specified in the path parameters. Deleting a company will not remove the contacts associated with it, but the association will be removed. Once a company is deleted, it cannot be restored. A successful deletion will result in a 204 No Content HTTP status code.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a company field

ID: delete_a_company_field
Operation: write
Entities: company field
Summary: The 'Delete a company field' API allows you to delete a specific company field by its ID. This action is irreversible, and all data stored in the corresponding field across all companies will be lost. The API requires basic authentication using an API key. The request must include the ID of the company field to be deleted in the path parameters. The API returns a 204 No Content status upon successful deletion, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a contact field

ID: delete_a_contact_field
Operation: write
Entities: contact field
Summary: The 'Delete a contact field' API allows you to delete a specific contact field by its ID. This action is irreversible, meaning once a contact field is deleted, it cannot be restored, and all data stored in this field across all contacts will be lost. The API requires basic authentication using an API key. The request must include the ID of the contact field to be deleted as a path parameter. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a conversation

ID: delete_a_conversation
Operation: write
Entities: conversation
Summary: The 'Delete a conversation' API allows you to delete a specific conversation by its ID. The request requires basic authentication using an API key in the headers. The conversation ID is specified as a path parameter. Upon successful deletion, the API returns a 204 No Content status, indicating that the conversation has been successfully deleted. There is no response body or additional headers returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Forum

ID: delete_a_forum
Operation: write
Entities: discussion, forum
Summary: The 'Delete a Forum' API allows you to delete a specific forum by its ID. The API requires a DELETE request to the endpoint '/api/v2/discussions/forums/[id]', where '[id]' is the ID of the forum you wish to delete. The request must include an 'Authorization' header with a basic authentication token in the format 'yourapikey:X'. Upon successful deletion, the API returns a 204 No Content status, indicating that the forum has been successfully deleted. There is no response body or additional headers returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Forum Category

ID: delete_a_forum_category
Operation: write
Entities: discussion, category, forum
Summary: The 'Delete a Forum Category' API allows users to delete a specific forum category by providing the category ID in the URL path. The request requires an API key for authentication, which should be included in the headers in the format 'yourapikey:X'. Upon successful deletion, the API returns a 204 No Content status, indicating that the category has been successfully deleted and there is no additional content to send in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Group

ID: delete_a_group
Operation: write
Entities: group
Summary: The 'Delete a Group' API endpoint allows you to disband a group by its ID. It does not delete the members of the group, only the group itself. Once a group is deleted, it cannot be restored. The request requires an API key for authentication, which should be included in the headers. The group ID is specified as a path parameter. The API returns a 204 No Content status upon successful deletion, indicating that the group has been disbanded.
Input Fields: Input Fields
Output Fields: Output Fields

Delete A Record

ID: delete_a_record
Operation: write
Entities: custom object, schema, record
Summary: The 'Delete A Record' API allows you to delete a specific record from a custom object schema using the DELETE HTTP method. You need to provide the 'schema-id' and 'record-id' as path parameters to specify which record to delete. The request must include an 'Authorization' header with your API key and a 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 204 No Content response, indicating that the record has been successfully deleted and there is no additional content to send in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a section

ID: delete_a_section
Operation: write
Entities: ticket, admin, section
Summary: The 'Delete a section' API allows an admin to delete a specific section within a ticket field. This action is irreversible, so caution is advised. The API requires the 'id' of the ticket field and the 'section_id' of the section to be deleted as path parameters. Authentication is done via an API key provided in the headers. The API does not require any query parameters or request body. Upon successful deletion, the API returns a 204 No Content status, indicating that the section has been deleted successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Service Group

ID: delete_a_service_group
Operation: write
Entities: service group
Summary: The Delete a Service Group API allows you to delete a specific service group by its ID. To use this API, you need to provide the API key in the Authorization header for authentication. The ID of the service group to be deleted must be specified in the path parameters. This API does not require any query parameters or request body. Upon successful deletion, the API returns a 204 No Content HTTP status, indicating that the service group has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Service Task

ID: delete_a_service_task
Operation: write
Entities: service task, ticket
Summary: The Delete a Service Task API allows you to delete a service task by specifying the ticket ID in the URL path. The request requires basic authentication using an API key. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Skill

ID: delete_a_skill
Operation: write
Entities: skill
Summary: The 'Delete a Skill' API allows an administrator to delete a specific skill by its ID. The request requires an API key for authentication, which should be included in the headers. The skill ID must be provided as a path parameter. Upon successful deletion, the API returns a 204 No Content status, indicating that the skill has been successfully deleted. There is no response body for this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Solution Article

ID: delete_a_solution_article
Operation: write
Entities: solution article, translation
Summary: The 'Delete a Solution Article' API allows users to delete a specific solution article by its ID. When an article is deleted, all its translated versions are also removed. The API requires an API key for authentication, which should be included in the request headers in the format 'yourapikey:X'. The ID of the article to be deleted must be specified in the path parameters. The API does not require any query parameters or request body. Upon successful deletion, the API returns a 204 No Content status, indicating that the article has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Solution Category

ID: delete_a_solution_category
Operation: write
Entities: solution category, translation
Summary: The 'Delete a Solution Category' API allows users to delete a specific solution category by its ID. When a category is deleted, all its translated versions are also removed. The request requires an API key for authentication, which should be included in the headers. The ID of the category to be deleted must be specified in the path parameters. The API responds with a 204 No Content status, indicating that the deletion was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Solution Folder

ID: delete_a_solution_folder
Operation: write
Entities: solution folder
Summary: The 'Delete a Solution Folder' API allows you to delete a specific solution folder by its ID. When a folder is deleted, all its translated versions are also removed. The API requires a DELETE request to the endpoint '/api/v2/solutions/folders/[id]', where '[id]' is the ID of the folder to be deleted. The request must include an 'Authorization' header with a basic authentication token. The API responds with a 204 No Content status, indicating that the folder has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a thread

ID: delete_a_thread
Operation: write
Entities: thread
Summary: The 'Delete a thread' API allows users to delete a specific thread identified by its ID. This action is irreversible, meaning once a thread is deleted, it cannot be restored. The API requires an API key for authentication, which should be included in the request headers. The thread ID must be specified in the path parameters. Upon successful deletion, the API returns a 204 No Content status, indicating that the thread has been successfully deleted and there is no additional content to send in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Ticket

ID: delete_a_ticket
Operation: write
Entities: ticket
Summary: The Delete a Ticket API allows you to delete a ticket by specifying its ID in the path parameters. The request requires an API key for authentication, which should be included in the headers. Upon successful deletion, the API returns a 204 No Content status, indicating that the ticket has been deleted. However, the ticket is not permanently removed and can be restored using the Restore Ticket API.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Ticket Field

ID: delete_a_ticket_field
Operation: write
Entities: ticket field
Summary: The 'Delete a Ticket Field' API allows administrators to delete a specific ticket field by its ID. This operation is irreversible, so caution is advised. The API requires an API key for authentication, which should be included in the request headers. The ID of the ticket field to be deleted must be specified in the path parameters. Upon successful deletion, the API returns a 204 No Content status, indicating that the ticket field has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Ticket Form

ID: delete_a_ticket_form
Operation: write
Entities: ticket form
Summary: The 'Delete a Ticket Form' API allows users to delete a specific ticket form by its ID. This action is irreversible, meaning once a ticket form is deleted, it cannot be restored. The API requires an API key for authentication, which should be included in the request headers. The ID of the ticket form to be deleted must be specified in the path parameters. Upon successful deletion, the API returns a 204 No Content HTTP status, indicating that the request was successful and the server has fulfilled the request but does not need to return an entity-body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Ticket Form's Field

ID: delete_a_ticket_forms_field
Operation: write
Entities: ticket form, field
Summary: The 'Delete a Ticket Form's Field' API allows users to delete a specific field from a ticket form in the Freshdesk system. The API requires the form ID and field ID as path parameters to identify the specific field to be deleted. The request must include an 'Authorization' header with the API key for authentication. Upon successful deletion, the API returns a 204 No Content status, indicating that the field has been successfully removed.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Time Entry

ID: delete_a_time_entry
Operation: write
Entities: time entry
Summary: The 'Delete a Time Entry' API allows users to delete a specific time entry by its ID. The API requires an API key for authentication, which should be included in the request headers in the format 'yourapikey:X'. The ID of the time entry to be deleted must be specified in the path parameters. Upon successful deletion, the API returns a 204 No Content status, indicating that the time entry has been deleted. Note that deleted time entries cannot be restored.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Topic

ID: delete_a_topic
Operation: write
Entities: topic
Summary: The 'Delete a Topic' API allows users to delete a specific discussion topic by its ID. The request requires an API key for authentication, which should be included in the headers as 'Authorization'. The topic ID must be specified in the path parameters. Once a topic is deleted using this API, it cannot be restored. The API responds with a 204 No Content status, indicating that the deletion was successful and there is no additional content to send in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Agent

ID: delete_an_agent
Operation: write
Entities: agent
Summary: The 'Delete an Agent' API allows you to delete an agent from the system. The API requires the agent's ID as a path parameter and uses basic authentication with an API key in the headers. Upon successful deletion, the agent is downgraded to a contact, and the API returns a 204 No Content status, indicating that the operation was successful and there is no additional content to send in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Archive Ticket

ID: delete_an_archive_ticket
Operation: write
Entities: ticket
Summary: The 'Delete an Archive Ticket' API allows users to delete a specific archived ticket from the system. The API requires the ticket ID as a path parameter and uses basic authentication with an API key in the headers. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and there is no additional content to send in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an attachment

ID: delete_an_attachment
Operation: write
Entities: attachment
Summary: The 'Delete an attachment' API allows users to delete a specific attachment by its ID from the Freshdesk system. The request requires basic authentication using an API key in the headers. The ID of the attachment to be deleted must be specified in the path parameters. Upon successful deletion, the API returns a 204 No Content status, indicating that the attachment has been successfully removed and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Automation Rule

ID: delete_an_automation_rule
Operation: write
Entities: automation, rule
Summary: The 'Delete an Automation Rule' API allows users to delete a specific automation rule by providing the 'id' of the rule and the 'automation_type_id'. The request requires an API key for authentication, which should be included in the headers. The endpoint is accessed via a DELETE request to '/api/v2/automations/[automation_type_id]/rules/[id]'. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and there is no additional content to send in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Email Mailbox

ID: delete_an_email_mailbox
Operation: write
Entities: email mailbox
Summary: The 'Delete an Email Mailbox' API allows users to delete an existing email mailbox by specifying its ID in the path parameters. This action is irreversible, and once the mailbox is deleted, any emails sent to this inbox will no longer be created as tickets. The API requires an API key for authentication, which should be included in the request headers. The endpoint returns a 204 No Content status upon successful deletion, indicating that the mailbox has been removed.
Input Fields: Input Fields
Output Fields: Output Fields

Delete message for thread

ID: delete_message_for_thread
Operation: write
Entities: message, collaboration, thread
Summary: The 'Delete message for thread' API allows users to delete a specific message from a thread using its ID. This action is irreversible, meaning once a message is deleted, it cannot be restored. The API requires an API key for authentication, which should be included in the request headers. The message ID must be specified in the path parameters. The API does not require any query parameters or request body. Upon successful deletion, the API returns a 204 No Content status, indicating that the message has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Permanently Delete a Contact

ID: delete_permanently_delete_a_contact
Operation: write
Entities: ticket, contact
Summary: The 'Permanently Delete a Contact' API is used to hard delete a contact from the portal, ensuring it is completely removed. This is particularly useful for GDPR compliance. The API requires the contact to be soft deleted first; otherwise, the 'force' parameter must be set to true to proceed with the hard delete. All tickets related to the contact will also be deleted and cannot be retrieved later. The API requires an API key for authentication and the contact ID as a path parameter. Optionally, a 'force' query parameter can be used to hard delete contacts that are not soft deleted. A successful request returns a 204 No Content status, while errors such as the contact not being soft deleted or not found return a 400 or 404 status, respectively.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Ticket User Access

ID: delete_remove_ticket_user_access
Operation: write
Entities: ticket, access, user
Summary: The 'Remove Ticket User Access' API allows you to delete user access to a specific ticket in the system. The API requires the ticket ID as a path parameter and an API key for authentication in the headers. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and there is no additional content to send in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Soft Delete a Contact

ID: delete_soft_delete_a_contact
Operation: write
Entities: contact
Summary: The 'Soft Delete a Contact' API allows users to delete a contact from the system using a DELETE request. The API requires the contact's unique identifier as a path parameter and uses basic authentication with an API key in the headers. Upon successful deletion, the API returns a 204 No Content status, indicating that the contact has been successfully deleted without returning any content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Summary

ID: delete_ticket_summary
Operation: write
Entities: ticket, summary
Summary: The Delete Ticket Summary API allows you to delete the summary of a specific ticket in the Freshdesk system. The API requires the ticket ID as a path parameter and an API key for authentication in the headers. The request does not require a body or query parameters. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and there is no additional content to send in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Unmonitor Forum

ID: delete_unmonitor_forum
Operation: write
Entities: discussion, user, forum
Summary: The 'Unmonitor Forum' API allows a user to stop monitoring a specific forum. The API requires the forum ID as a path parameter and the user ID as a query parameter. The request must include an Authorization header with the API key for authentication. Upon successful execution, the API returns a 204 No Content status, indicating that the user has successfully stopped monitoring the forum.
Input Fields: Input Fields
Output Fields: Output Fields

Unmonitor Topic

ID: delete_unmonitor_topic
Operation: write
Entities: discussion, topic, user
Summary: The Unmonitor Topic API allows a user to stop monitoring a specific discussion topic. The API requires the topic ID and the user ID as path and query parameters, respectively. The request must include an API key for authentication in the headers. The body of the request should also contain the user ID. Upon successful execution, the API returns a 204 No Content status, indicating that the user has successfully stopped monitoring the topic.
Input Fields: Input Fields
Output Fields: Output Fields

Get a thread

ID: get_a_thread
Operation: read
Entities: thread, participant, linked object
Summary: The 'Get a thread' API retrieves details of a specific thread identified by its ID. The request requires an API key for authentication, which should be included in the Authorization header. The thread ID is specified as a path parameter. The response includes detailed information about the thread, such as its ID, type, title, creator, parent and anchor objects, participants, linked objects, creation and update timestamps, additional information, and read status.
Input Fields: Input Fields
Output Fields: Output Fields

List All Conversations of an Archive Ticket

ID: get_all_conversations_of_an_archive_ticket
Operation: read
Entities: attachment, ticket, conversation
Summary: This API retrieves all conversations associated with a specific archived ticket in the Freshdesk system. The request requires an API key for authentication and the content type must be 'application/json'. The ticket ID must be provided as a path parameter. The response includes details of each conversation such as the body text, HTML content, sender and recipient emails, timestamps, and any attachments.
Input Fields: Input Fields
Output Fields: Output Fields

List All Satisfaction Ratings of a Ticket

ID: get_all_satisfaction_ratings_of_a_ticket
Operation: read
Entities: ticket, survey, satisfaction rating
Summary: This API endpoint retrieves all satisfaction ratings for a specific ticket. The request requires an API key for authentication, which should be included in the headers. The ticket ID must be specified in the path parameters. The response includes an array of satisfaction ratings, each containing details such as the rating ID, survey ID, user ID, agent ID, feedback, group ID, ticket ID, ratings for questions, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get Associated Tickets

ID: get_associated_tickets
Operation: read
Entities: ticket, status, priority
Summary: The 'Get Associated Tickets' API retrieves all tickets associated with a specific ticket ID. The request requires an API key for authentication and the content type must be 'application/json'. The ticket ID is specified as a path parameter. The response includes an array of associated tickets, each with details such as ticket ID, group ID, priority, requester ID, responder ID, source, company ID, status, subject, product ID, type, due dates, escalation status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Export Status

ID: get_company_export_status
Operation: read
Entities: job, field, company
Summary: The 'Get Company Export Status' API endpoint allows users to check the status of a company export job initiated in Freshdesk. This endpoint requires the company export ID as a path parameter and returns the status of the export job. If the export is completed, it provides a download URL for the exported CSV file. The API requires basic authentication using an API key and expects the 'Content-Type' header to be 'application/json'. The response includes the export ID, status, and download URL.
Input Fields: Input Fields
Output Fields: Output Fields

Contact Export

ID: get_contact_export
Operation: read
Entities: field, contact, export
Summary: The Contact Export API allows users to export contact data from Freshdesk. The process involves two steps: initiating the export to receive a contact export ID, and then using this ID to retrieve the URL of the exported CSV file. The API requires a 'Content-Type' header set to 'application/json' and a path parameter 'id' which is the contact export ID. The response includes the export ID, status, and a download URL for the CSV file. The exported file is available for 15 days after completion.
Input Fields: Input Fields
Output Fields: Output Fields

Currently Authenticated Agent

ID: get_currently_authenticated_agent
Operation: read
Entities: agent, role, skill
Summary: The 'Currently Authenticated Agent' API retrieves information about the currently authenticated agent in the Freshdesk system. It requires an API key for authentication, which should be included in the request headers. The response includes details such as the agent's availability, roles, skills, and contact information. The contact information includes the agent's email, job title, language preference, and time zone, among other details.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of Canned Responses in a Folder

ID: get_details_of_canned_responses_in_a_folder
Operation: read
Entities: attachment, canned response, folder
Summary: This API retrieves all the details of canned responses within a specified folder. The request requires an API key for authentication, which should be included in the headers. The folder ID must be specified in the path parameters. The response includes an array of canned responses, each with attributes such as id, title, folder_id, content, content_html, and attachments. Attachments include details like id, name, content type, size, and URLs.
Input Fields: Input Fields
Output Fields: Output Fields

Filter CompaniesBETA

ID: get_filter_companiesbeta
Operation: read
Entities: query, field, company
Summary: The Filter CompaniesBETA API allows users to filter and retrieve a list of companies based on custom company fields defined in their account. The API uses a URL encoded query string to specify the filtering criteria, which can include logical and relational operators. The query string must be enclosed in double quotes and can be up to 512 characters long. The API returns a paginated list of companies, with each page containing up to 30 companies. The response includes the total count of matching companies and detailed information about each company, such as its ID, name, description, domains, custom fields, and timestamps for creation and last update. The API requires basic authentication using an API key.
Input Fields: Input Fields
Output Fields: Output Fields

Filter ContactsBETA

ID: get_filter_contactsbeta
Operation: read
Entities: contact field, query, contact
Summary: The Filter ContactsBETA API allows users to filter through contacts using custom contact fields created in their account. The API returns a list of contacts matching the specified contact fields. The query must be URL encoded and can include logical operators (AND, OR) and relational operators (>, <) for date and numeric fields. The query string can be up to 512 characters long and must be enclosed in double quotes. The API returns 30 objects per page, and pagination is supported with a page parameter. The response includes the total count of results and detailed information about each contact, such as active status, address, company ID, email, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Filter Records Of A Custom Object

ID: get_filter_records_of_a_custom_object
Operation: read
Entities: custom object, schema, record
Summary: The 'Filter Records Of A Custom Object' API allows users to retrieve records from a custom object schema by applying filters on specific fields. The API requires the schema ID as a path parameter and supports filtering through query parameters such as field-name, operator, and value. Optional query parameters include sort_by for sorting the results and page_size for pagination. The response includes a list of records with details such as display_id, created_time, updated_time, and data fields like customer_id, customer_name, and age. Metadata and pagination links are also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Filter Tickets

ID: get_filter_tickets
Operation: read
Entities: query, field, ticket
Summary: The Filter Tickets API allows users to filter and retrieve a list of tickets based on custom ticket fields. The API supports various ticket fields such as agent_id, group_id, priority, status, tag, type, due_by, fr_due_by, created_at, updated_at, and custom fields. The query parameter must be URL encoded and can include logical operators (AND, OR) and relational operators (>, <) for date and numeric fields. The API returns a paginated list of tickets with a maximum of 30 tickets per page. The response includes the total count of matching tickets and detailed information about each ticket, such as cc_emails, priority, status, subject, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

List a specific Section details

ID: get_list_a_specific_section_details
Operation: read
Entities: ticket field, choice, section
Summary: This API endpoint retrieves the details of a specific section within a ticket field in the Freshdesk system. The request requires authentication via an API key provided in the headers. The path parameters include 'id', which is the ID of the ticket field, and 'section_id', which is the ID of the section to be retrieved. The response includes details of the section such as its ID, label, parent ticket field ID, associated choice IDs, ticket field IDs, and a boolean indicating if it is FSM.
Input Fields: Input Fields
Output Fields: Output Fields

List All Agents

ID: get_list_all_agents
Operation: read
Entities: filter, agent, contact
Summary: The 'List All Agents' API endpoint allows users to retrieve a list of agents from the Freshdesk system. Users can apply filters to narrow down the results based on specific criteria such as email, mobile, phone, and state (fulltime or occasional). The API requires an API key for authentication, which should be included in the request headers. The response includes detailed information about each agent, including their availability, contact details, and timestamps for creation and updates. The API supports URL-encoded query strings for filtering.
Input Fields: Input Fields
Output Fields: Output Fields

List All Agents in a Group

ID: get_list_all_agents_in_a_group
Operation: read
Entities: agent, role, group
Summary: The 'List All Agents in a Group' API retrieves a list of all agents associated with a specific group in Freshdesk. The request requires an API key for authentication, which should be included in the Authorization header. The group ID must be specified in the path parameters. The response includes details about each agent, such as their ID, ticket scope, write access, role IDs, contact information (name, avatar, email), creation and update timestamps, and whether they are Freshcaller or Freshchat agents. Note that the 'freshcaller_agent' and 'freshchat_agent' fields are only visible if the Freshdesk account is an Omnichannel account.
Input Fields: Input Fields
Output Fields: Output Fields

List All Automation Rules

ID: get_list_all_automation_rules
Operation: read
Entities: ticket, automation rule, event
Summary: The 'List All Automation Rules' API retrieves all automation rules for a specified automation type in Freshdesk. The API requires an 'automation_type_id' as a path parameter to specify the type of automation, such as rules that run on ticket creation, updates, or hourly triggers. The request must include an 'Authorization' header with the API key. The response includes a list of rules with details such as name, position, active status, performer, events, conditions, actions, and metadata like the count of rules and whether cascading rules are enabled.
Input Fields: Input Fields
Output Fields: Output Fields

List All Business Hours

ID: get_list_all_business_hours
Operation: read
Entities: business hour
Summary: The 'List All Business Hours' API allows users to retrieve all business hours configured in their Freshdesk account. The API requires basic authentication using an API key. The response includes an array of business hour entries, each with details such as id, name, description, time zone, default status, specific business hours for each weekday, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Canned Responses in a Folder

ID: get_list_all_canned_responses_in_a_folder
Operation: read
Entities: folder, canned response
Summary: This API endpoint retrieves all canned responses within a specified folder. The request requires basic authentication using an API key and the folder ID as a path parameter. The response includes the folder's ID, name, a list of canned responses with their IDs and titles, and timestamps for when the folder was created and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

List All Comments in a Topic

ID: get_list_all_comments_in_a_topic
Operation: read
Entities: comment, topic, user
Summary: The 'List All Comments in a Topic' API allows users to retrieve all comments associated with a specific topic in a discussion forum. The API requires the topic ID as a path parameter and uses basic authentication with an API key. The response includes an array of comments, each containing details such as the comment ID, text content, HTML content, topic ID, forum ID, user ID, and timestamps for creation and last update. Additional flags indicate if the comment is marked as an answer, published, spam, or in the trash.
Input Fields: Input Fields
Output Fields: Output Fields

List All Companies

ID: get_list_all_companies
Operation: read
Entities: filter, custom field, company
Summary: The 'List All Companies' API endpoint allows users to retrieve a list of all companies. Users can apply filters to view specific companies that match certain criteria, such as those updated since a particular date. The request requires basic authentication using an API key. The response includes detailed information about each company, such as its name, description, associated domains, custom fields, health score, account tier, renewal date, and industry. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

List all company fields

ID: get_list_all_company_fields
Operation: read
Entities: agent, field, company
Summary: The 'List all company fields' API endpoint allows users to retrieve a list of all company fields available in the system. This API uses a GET request to the endpoint '/api/v2/company_fields'. The request requires basic authentication using an API key. The response is an array of objects, each representing a company field with details such as 'id', 'name', 'label', 'position', 'required_for_agents', 'type', 'default', 'created_at', 'updated_at', and 'choices' if applicable. This API is useful for obtaining metadata about company fields, which can include default fields like 'Company Name', 'Description', 'Notes', and custom fields with specific choices.
Input Fields: Input Fields
Output Fields: Output Fields

List all contact fields

ID: get_list_all_contact_fields
Operation: read
Entities: field, customer, contact
Summary: The 'List all contact fields' API endpoint allows users to retrieve details of all contact fields available in the system. It requires an API key for authentication, which should be included in the request headers. The API responds with an array of contact field objects, each containing details such as the field's name, label, position, type, and whether it is editable or required for agents and customers. The response also includes timestamps for when each field was created and last updated. This API is useful for understanding the structure and requirements of contact fields in the system.
Input Fields: Input Fields
Output Fields: Output Fields

List All Contacts

ID: get_list_all_contacts
Operation: read
Entities: filter, contact, company
Summary: The 'List All Contacts' API allows users to retrieve a list of contacts from the Freshdesk system. Users can apply various filters to narrow down the results, such as filtering by email, mobile, phone, company ID, state, and updated_since date-time. The API requires an API key for authentication, which should be included in the request headers. The response includes detailed information about each contact, such as their email, name, language, time zone, and custom fields like department and Facebook profile. The API returns all unblocked and undeleted contacts by default.
Input Fields: Input Fields
Output Fields: Output Fields

List All Conversations of a Ticket

ID: get_list_all_conversations_of_a_ticket
Operation: read
Entities: ticket, conversation, user
Summary: The 'List All Conversations of a Ticket' API retrieves all conversations associated with a specific ticket in the Freshdesk system. The API requires an API key for authentication, which should be included in the headers as 'Authorization'. The 'Content-Type' header must be set to 'application/json'. The ticket ID is a required path parameter, and an optional query parameter 'page' can be used for pagination. The response includes an array of conversation objects, each containing details such as the conversation body, sender and recipient emails, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

List All Email Configs

ID: get_list_all_email_configs
Operation: read
Entities: email configuration
Summary: The 'List All Email Configs' API retrieves a list of all email configurations associated with a Freshdesk account. The request requires basic authentication using an API key. The response is an array of email configuration objects, each containing details such as the unique ID, name, associated product ID, email addresses for sending and replying, group ID, primary role status, active status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Email Mailboxes

ID: get_list_all_email_mailboxes
Operation: read
Entities: product, mailbox, group
Summary: The 'List All Email Mailboxes' API endpoint allows users to retrieve a list of all email mailboxes. Users can apply various filters such as 'support_email', 'product_id', 'group_id', and 'active' to narrow down the results. Additionally, the results can be ordered by fields like 'product_id' or 'group_id' using the 'order_by' and 'order_type' query parameters. The API requires basic authentication via an API key. The response includes detailed information about each mailbox, such as its ID, name, support email, group ID, active status, mailbox type, and timestamps for creation and last update. For custom mailboxes, additional configuration details for incoming and outgoing mail servers are provided.
Input Fields: Input Fields
Output Fields: Output Fields

List All Folders

ID: get_list_all_folders
Operation: read
Entities: folder, canned response
Summary: The 'List All Folders' API endpoint retrieves all the canned response folders available in the system. It requires basic authentication using an API key. The request does not require any path parameters, query parameters, or request body. The response is an array of folder objects, each containing details such as the folder's unique ID, name, whether it is personal, the count of responses it contains, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List all Folders in a Folder

ID: get_list_all_folders_in_a_folder
Operation: read
Entities: category, article, folder
Summary: This API endpoint retrieves a list of all subfolders within a specified parent folder in a given language. The request requires basic authentication using an API key. The path parameters include 'folder_id', which specifies the ID of the parent folder, and 'language_code', which specifies the language of the subfolders. The response is an array of folder objects, each containing details such as the folder's ID, name, description, parent folder ID, hierarchy, article count, subfolder count, visibility, creation and update timestamps, and associated company IDs.
Input Fields: Input Fields
Output Fields: Output Fields

List All Forum Categories

ID: get_list_all_forum_categories
Operation: read
Entities: discussion, forum category
Summary: The 'List All Forum Categories' API retrieves a list of all forum categories available in the system. It requires basic authentication using an API key. The request does not require any path parameters, query parameters, or request body. The response is an array of forum category objects, each containing an 'id', 'name', 'description', 'created_at', and 'updated_at' timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

List All Forums in a Category

ID: get_list_all_forums_in_a_category
Operation: read
Entities: discussion, category, forum
Summary: The 'List All Forums in a Category' API retrieves all forums within a specified category. The request requires a category ID as a path parameter and uses basic authentication with an API key. The response includes an array of forums, each with details such as ID, name, description, position, category ID, type, visibility, and counts of topics and posts.
Input Fields: Input Fields
Output Fields: Output Fields

List All Groups

ID: get_list_all_groups
Operation: read
Entities: ticket, group, business hour
Summary: The 'List All Groups' API endpoint retrieves a list of all groups in the system. It requires an API key for authentication, which should be included in the headers as 'Authorization: yourapikey:X'. The response is an array of group objects, each containing details such as the group's ID, name, description, business hour ID, escalation user ID, unassigned duration, auto ticket assignment status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Monitored Topics

ID: get_list_all_monitored_topics
Operation: read
Entities: user, topic, forum
Summary: The 'List All Monitored Topics' API allows users to retrieve a list of discussion topics that are being monitored by a specific user. The API requires an API key for authentication, which should be included in the request headers. The 'user_id' query parameter can be used to specify the user whose monitored topics are to be listed. If 'user_id' is not provided, the API will assume the user is the one whose credentials were used to make the API call. Only administrators have the privilege to view the list of topics monitored by other users. The response includes details about each topic, such as its ID, title, forum ID, user ID, lock status, publication status, and timestamps for creation, updates, and replies.
Input Fields: Input Fields
Output Fields: Output Fields

List All Participated Topics

ID: get_list_all_participated_topics
Operation: read
Entities: discussion, topic, user
Summary: The 'List All Participated Topics' API allows users to retrieve a list of discussion topics that a specific user has participated in, either by creating or commenting. The API requires an API key for authentication, which should be included in the request headers. The 'user_id' query parameter can be used to specify the user whose participated topics are to be retrieved. If 'user_id' is not provided, the API will assume the user is the one associated with the API key used for the request. The response includes an array of topics with details such as topic ID, title, forum ID, user ID, lock status, publication status, and timestamps for creation, update, and last reply.
Input Fields: Input Fields
Output Fields: Output Fields

List All Products

ID: get_list_all_products
Operation: read
Entities: product
Summary: The 'List All Products' API endpoint retrieves a list of all products available in the system. It requires an API key for authentication, which should be included in the request headers in the format 'yourapikey:X'. The response is an array of product objects, each containing details such as the product's unique ID, name, description, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Roles

ID: get_list_all_roles
Operation: read
Entities: user, permission, role
Summary: The 'List All Roles' API endpoint retrieves a list of all roles available in the Freshdesk system. It requires basic authentication using an API key. The request does not require any path or query parameters, nor does it require a request body. The response is an array of role objects, each containing details such as the role's ID, name, description, whether it is a default role, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Scenario Automations

ID: get_list_all_scenario_automations
Operation: read
Entities: action, scenario automation
Summary: The 'List All Scenario Automations' API retrieves all scenario automations available in your Freshdesk account. It requires basic authentication using an API key. The response is an array of scenario automation objects, each containing details such as id, name, description, actions, privacy status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List All Sections for a Ticket Field

ID: get_list_all_sections_for_a_ticket_field
Operation: read
Entities: ticket field, section
Summary: This API endpoint retrieves all sections associated with a specific ticket field in the Freshdesk system. The request requires a basic authentication header with an API key and the ID of the ticket field as a path parameter. The response includes an array of sections, each with details such as the section ID, label, parent ticket field ID, associated choice IDs, ticket field IDs, and a boolean indicating if it is a field service management section.
Input Fields: Input Fields
Output Fields: Output Fields

List all Skills

ID: get_list_all_skills
Operation: read
Entities: condition, agent, skill
Summary: The 'List all Skills' API endpoint retrieves a list of all skills available in the system. It requires an API key for authentication, which should be included in the 'Authorization' header. The endpoint does not require any path parameters, query parameters, or request body. The response is an array of skill objects, each containing details such as the skill's ID, name, rank, creation and update timestamps, associated agents, match type, and conditions. Each condition specifies a resource type, field name, operator, and values.
Input Fields: Input Fields
Output Fields: Output Fields

List All SLA Policies

ID: get_list_all_sla_policies
Operation: read
Entities: sla policy, escalation, priority
Summary: The 'List All SLA Policies' API endpoint retrieves a list of all Service Level Agreement (SLA) policies configured in the system. It requires an API key for authentication, which should be included in the request headers. The response is an array of SLA policy objects, each containing details such as the policy ID, name, description, active status, default status, position, SLA targets for different priorities, applicable entities (companies, groups, sources, ticket types, products), escalation details, and timestamps for creation and last update. This API is useful for managing and reviewing SLA policies within the system.
Input Fields: Input Fields
Output Fields: Output Fields

List all Solution Articles in a Folder

ID: get_list_all_solution_articles_in_a_folder
Operation: read
Entities: solution article, category, folder
Summary: This API endpoint retrieves all solution articles within a specified folder in Freshdesk. The request requires basic authentication using an API key. The folder ID is a required path parameter, while the language code is optional. The response includes a list of articles with details such as article ID, type, category ID, folder ID, hierarchy, thumbs up/down counts, hits, SEO data, agent ID, title, description, status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List all Solution Categories

ID: get_list_all_solution_categories
Operation: read
Entities: solution category
Summary: This API endpoint retrieves a list of solution categories from the Freshdesk platform. It supports optional language translation by specifying a language code in the path parameter. The request requires an API key for authentication, provided in the headers. The response includes an array of solution categories, each with details such as id, name, description, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List all Solution Folders in a Category

ID: get_list_all_solution_folders_in_a_category
Operation: read
Entities: category, solution, folder
Summary: This API endpoint retrieves all solution folders within a specified category and language. The request requires basic authentication using an API key. The path parameters include 'category_id' to specify the category and 'language_code' to specify the language of the folders. The response returns an array of folders, each containing details such as 'id', 'name', 'description', 'parent_folder_id', 'hierarchy', 'articles_count', 'sub_folders_count', 'visibility', 'created_at', 'updated_at', and 'company_ids'.
Input Fields: Input Fields
Output Fields: Output Fields

List all Surveys

ID: get_list_all_surveys
Operation: read
Entities: question, survey, rating
Summary: The 'List all Surveys' API endpoint allows users to retrieve a list of surveys from the Freshdesk platform. Users can filter the surveys by state using query parameters. The request requires an API key for authentication, which should be included in the headers. The response includes an array of survey objects, each containing details such as the survey ID, title, questions, and timestamps for creation and last update. Each question within a survey includes its ID, label, and accepted ratings.
Input Fields: Input Fields
Output Fields: Output Fields

List All Ticket Fields

ID: get_list_all_ticket_fields
Operation: read
Entities: ticket field, customer, agent
Summary: The 'List All Ticket Fields' API endpoint allows users to retrieve a list of all ticket fields available in the system. The API requires an API key for authentication, which should be included in the request headers. Users can filter the ticket fields by type using query parameters. The response includes detailed information about each ticket field, such as its ID, description, label, name, position, type, and various flags indicating its properties and visibility. The API is useful for agents who need to view or manage ticket fields in the system.
Input Fields: Input Fields
Output Fields: Output Fields

List All Ticket Forms

ID: get_list_all_ticket_forms
Operation: read
Entities: portal, widget, ticket form
Summary: The 'List All Ticket Forms' API endpoint retrieves a list of all ticket forms available in the system. The API requires basic authentication using an API key. The agent whose credentials are used must have authorization to view or create ticket forms. The API supports an optional query parameter 'include' to fetch additional data such as 'portals'. The response includes details of each ticket form such as its ID, name, title, whether it is the default form, description, creation and update timestamps, the ID of the agent who last updated it, and associated portals.
Input Fields: Input Fields
Output Fields: Output Fields

List All Tickets

ID: get_list_all_tickets
Operation: read
Entities: filter, ticket, requester
Summary: The 'List All Tickets' API allows users to retrieve a list of tickets from the Freshdesk system. Users can apply various filters to narrow down the results, such as filtering by requester ID, email, company ID, or updated date. The API supports sorting by different fields and order types. Additional details can be embedded in the response using the 'include' parameter, which may incur additional API credits. The response includes detailed information about each ticket, such as email addresses, priority, status, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

List All Time Entries

ID: get_list_all_time_entries
Operation: read
Entities: filter, time entry, company
Summary: The 'List All Time Entries' API endpoint allows users to retrieve a list of time entries from the Freshdesk system. Users can apply various filters to narrow down the results, such as filtering by company ID, agent ID, execution time range, and billable status. The API requires basic authentication using an API key. The response includes details about each time entry, such as whether it is billable, any associated notes, the status of the timer, and timestamps for creation, update, execution, and start time.
Input Fields: Input Fields
Output Fields: Output Fields

List All Time Entries of a Ticket

ID: get_list_all_time_entries_of_a_ticket
Operation: read
Entities: ticket, agent, time entry
Summary: The 'List All Time Entries of a Ticket' API retrieves all time entries associated with a specific ticket. The request requires an API key for authentication, which should be included in the headers. The ticket ID must be specified in the path parameters. Optionally, a page number can be provided in the query parameters for pagination. The response includes an array of time entry objects, each containing details such as whether the entry is billable, the agent ID, time spent, and timestamps for creation, update, execution, and start time.
Input Fields: Input Fields
Output Fields: Output Fields

List All Topics in a Forum

ID: get_list_all_topics_in_a_forum
Operation: read
Entities: user, topic, forum
Summary: The 'List All Topics in a Forum' API retrieves all topics within a specified forum. The request requires the forum ID as a path parameter and uses basic authentication with an API key. The response includes an array of topics, each with details such as the topic ID, title, forum ID, user ID, lock status, publish status, number of posts, views, votes, and timestamps for creation, update, and last reply.
Input Fields: Input Fields
Output Fields: Output Fields

List all watchers

ID: get_list_all_watchers
Operation: read
Entities: ticket, watcher
Summary: The 'List all watchers' API retrieves a list of all watchers for a specific ticket in Freshdesk. The request requires an API key for authentication, which should be included in the headers. The ticket ID must be specified in the path parameters. The response returns a JSON object containing an array of watcher IDs associated with the specified ticket.
Input Fields: Input Fields
Output Fields: Output Fields

Get Message for Thread

ID: get_message_for_thread
Operation: read
Entities: message, participant, thread
Summary: The 'Get Message for Thread' API retrieves a specific message from a thread using its ID. The request requires basic authentication via an API key and the message ID as a path parameter. The response includes detailed information about the message, such as its HTML and plain text content, creation and update timestamps, participant details, and additional metadata like attachment IDs and email failure information.
Input Fields: Input Fields
Output Fields: Output Fields

Monitoring Status For Forum

ID: get_monitoring_status_for_forum
Operation: read
Entities: user, administrator, forum
Summary: This API checks if a specific forum is being monitored by a user. It requires the forum ID as a path parameter and optionally a user ID as a query parameter. If the user ID is not provided, the API assumes the user is the one authenticated by the API key. Only administrators can check the monitoring status for other users. A 204 HTTP status code indicates the forum is being monitored, while a 404 status code indicates it is not.
Input Fields: Input Fields
Output Fields: Output Fields

Monitoring Status For Topic

ID: get_monitoring_status_for_topic
Operation: read
Entities: user, administrator, topic
Summary: This API checks if a specific user is monitoring a given topic. It requires the topic ID as a path parameter and optionally a user ID as a query parameter. If the user ID is not provided, the API assumes the user is the one authenticated by the API key. Only administrators can check the monitoring status for other users. A 204 HTTP status code indicates the topic is being monitored, while a 404 status code indicates it is not.
Input Fields: Input Fields
Output Fields: Output Fields

Get Prime Association of a Ticket

ID: get_prime_association_of_a_ticket
Operation: read
Entities: ticket, association, priority
Summary: The 'Get Prime Association of a Ticket' API retrieves detailed information about a specific ticket's prime association in the Freshdesk system. The API requires an API key for authentication and the ticket ID as a path parameter. The response includes various details about the ticket such as its ID, group ID, priority, requester and responder IDs, source, company ID, status, subject, product ID, type, due dates, escalation status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get Quoted Text for Message

ID: get_quoted_text_for_message
Operation: read
Entities: message, quote
Summary: The 'Get Quoted Text for Message' API retrieves the quoted text for a specific message identified by its ID. The request requires an API key for authentication, which should be included in the headers. The message ID is specified as a path parameter. The response returns the quoted text in HTML format, encapsulated within a 'quoted_text' field in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve A Record

ID: get_retrieve_a_record
Operation: read
Entities: record, custom object, field
Summary: The Retrieve A Record API allows you to fetch a specific record from an existing Custom Object by providing the schema ID and record ID as path parameters. The request requires an API key for authentication and must specify the content type as application/json. The response includes the record's display ID, creation and update times, and a data object containing fields such as license number, customer ID, email, and status. The version property is crucial for tracking revisions and preventing data loss during updates.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Records

ID: get_retrieve_all_records
Operation: read
Entities: customer, schema, record
Summary: The Retrieve All Records API allows you to fetch all records for a specific schema identified by the schema-id. The API requires authentication via an API key and accepts optional query parameters such as page_size to control the number of records returned per page. The response includes a list of records with details such as display_id, created_time, updated_time, and customer data including customer_id, customer_name, and age. Metadata about the primary field name is also included. Pagination links are provided in the response to navigate through the records.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Existing Custom Objects

ID: get_retrieve_existing_custom_objects
Operation: read
Entities: custom object, schema, field
Summary: The 'Retrieve Existing Custom Objects' API endpoint allows users to fetch all existing custom object schemas from the system. The API requires an API key for authentication, which should be included in the 'Authorization' header. The request must also specify 'Content-Type' as 'application/json'. The response includes a list of custom object schemas, each containing details such as the name, prefix, version, and fields. Each field within a schema has attributes like name, label, type, position, and whether it is required, editable, visible, filterable, or searchable.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve The Count Of Records

ID: get_retrieve_the_count_of_records
Operation: read
Entities: custom object, schema, record
Summary: The 'Retrieve The Count Of Records' API endpoint allows users to get the count of records for a specific schema. The request requires an API key for authentication, which should be included in the 'Authorization' header. The 'Content-Type' header must be set to 'application/json'. The 'schema_id' path parameter is required to specify the schema for which the record count is to be retrieved. The response returns a JSON object containing the 'count' of records for the specified schema.
Input Fields: Input Fields
Output Fields: Output Fields

Search Agents

ID: get_search_agents
Operation: read
Entities: agent
Summary: The Search Agents API allows users to search for agents by their name or email in a case-insensitive manner. The search term must be a complete word or prefix of the agent's name or email. The API requires a basic authentication token in the headers and a 'term' query parameter to specify the search keyword. The response is an array of agent objects, each containing the agent's id, name, email, and avatar URL (if available).
Input Fields: Input Fields
Output Fields: Output Fields

Search Companies

ID: get_search_companies
Operation: read
Entities: company
Summary: The Search Companies API allows users to search for companies by their name. The search is case insensitive and does not support substring search. For example, a company named 'Acme Corporation' can be found using 'acme', 'Ac', 'Corporation', or 'Co', but not with 'cme' or 'orporation'. The API requires a basic authentication token in the headers and a 'name' query parameter to specify the company name to search for. The response includes a list of companies with their unique IDs and names.
Input Fields: Input Fields
Output Fields: Output Fields

Search Contacts

ID: get_search_contacts
Operation: read
Entities: contact
Summary: The Search Contacts API allows users to search for contacts by their name using a keyword. The search is case insensitive and does not support substring searches. For example, a contact named 'John Jonz' can be found using 'john', 'Joh', 'Jonz', or 'jon', but not with 'hn' or 'nz'. The API requires basic authentication using an API key. The request includes a query parameter 'term' which is the keyword for searching. The response is an array of contact objects, each containing an 'id' and 'name'.
Input Fields: Input Fields
Output Fields: Output Fields

Search solution articles

ID: get_search_solution_articles
Operation: read
Entities: category, article, folder
Summary: The 'Search solution articles' API allows users to search for solution articles in their Freshdesk account using a specified keyword. The API requires a GET request to the endpoint with a query parameter 'term' that specifies the keyword to search for. The request must include an 'Authorization' header for basic authentication using an API key. The response is an array of solution articles, each containing details such as the article ID, type, category ID, folder ID, hierarchy, visibility, agent ID, path, modification timestamps, language ID, title, status, creation and update timestamps, description in HTML and plain text, category name, and folder name.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve A Specific Custom Object

ID: get_specific_custom_object
Operation: read
Entities: custom object, schema, field
Summary: The 'Retrieve A Specific Custom Object' API allows users to fetch details of a specific custom object schema by its ID. The request requires an API key for authentication and the schema ID as a path parameter. The response includes details such as the name, prefix, version, and fields of the custom object. Each field contains information like its ID, name, label, type, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

View Ticket Summary

ID: get_ticket_summary
Operation: read
Entities: summary, ticket, attachment
Summary: The 'View Ticket Summary' API allows users to retrieve a summary of a specific ticket by its ID. The request requires an API key for authentication and must specify the ticket ID in the path parameters. The response includes the HTML and plain text summary of the ticket, along with metadata such as the summary ID, user ID, ticket ID, creation and update timestamps, and any associated attachments or cloud files.
Input Fields: Input Fields
Output Fields: Output Fields

Get Ticket User Access

ID: get_ticket_user_access
Operation: read
Entities: ticket, user access
Summary: The 'Get Ticket User Access' API retrieves the list of user IDs who have access to a specific ticket. The request requires a path parameter 'id' which is the ID of the ticket. The request must include an 'Authorization' header for basic authentication. The response returns a JSON object containing an array of 'user_ids' who have access to the ticket.
Input Fields: Input Fields
Output Fields: Output Fields

View a Business Hour

ID: get_view_a_business_hour
Operation: read
Entities: time zone, business hour, roster
Summary: The 'View a Business Hour' API allows users to retrieve details of a specific business hour by its ID. The request requires an API key for authentication, which should be included in the headers. The ID of the business hour to be viewed must be specified in the path parameters. The response includes details such as the name, description, time zone, and the specific business hours for each weekday, along with timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Canned Response

ID: get_view_a_canned_response
Operation: read
Entities: attachment, canned response, folder
Summary: The 'View a Canned Response' API allows users to retrieve details of a specific canned response by its ID. The request requires an API key for authentication and must specify the content type as 'application/json'. The ID of the canned response is passed as a path parameter. The response includes details such as the ID, title, folder ID, content in both text and HTML formats, any attachments, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Company

ID: get_view_a_company
Operation: read
Entities: company
Summary: The 'View a Company' API endpoint allows users to retrieve detailed information about a specific company using its unique identifier. The request requires an API key for authentication, which should be included in the headers. The company ID must be specified in the path parameters. The response includes various details about the company, such as its name, description, associated domains, custom fields like website and address, creation and update timestamps, health score, account tier, renewal date, and industry.
Input Fields: Input Fields
Output Fields: Output Fields

View a Company Field

ID: get_view_a_company_field
Operation: read
Entities: field, company, industry
Summary: The 'View a Company Field' API allows users to retrieve details of a specific company field by its ID. The request requires an API key for authentication, which should be included in the headers. The path parameter 'id' is required to specify the company field to be viewed. The response includes details such as the field's name, label, position, type, and whether it is required for agents. It also provides a list of choices available for the field, each with its own ID, label, value, and position.
Input Fields: Input Fields
Output Fields: Output Fields

View a Contact

ID: get_view_a_contact
Operation: read
Entities: contact, custom field, company
Summary: The 'View a Contact' API allows you to retrieve detailed information about a specific contact in the Freshdesk system. You need to provide the contact ID as a path parameter. The request must include an API key for authentication in the headers, along with the 'Content-Type' set to 'application/json'. The response includes various details about the contact such as their email, name, associated company ID, language, time zone, and custom fields. It also provides information about the contact's avatar and other companies they are associated with.
Input Fields: Input Fields
Output Fields: Output Fields

View A Forum

ID: get_view_a_forum
Operation: read
Entities: discussion, topic, forum
Summary: The 'View A Forum' API allows users to retrieve details of a specific forum by its ID. The request requires basic authentication using an API key. The forum ID is specified as a path parameter. The response includes details such as the forum's ID, name, description, position, category ID, type, visibility, and counts of topics and posts.
Input Fields: Input Fields
Output Fields: Output Fields

View a Forum Category

ID: get_view_a_forum_category
Operation: read
Entities: discussion, category, forum
Summary: The 'View a Forum Category' API allows users to retrieve details of a specific forum category by its ID. The request requires basic authentication using an API key in the headers. The path parameter 'id' is mandatory and specifies the forum category to be viewed. The response includes the category's ID, name, description, creation timestamp, and last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

View a Group

ID: get_view_a_group
Operation: read
Entities: agent, group
Summary: The 'View a Group' API endpoint allows users to retrieve details of a specific group by its unique identifier. The request requires basic authentication using an API key. The path parameter 'id' is mandatory and specifies the group to be retrieved. The response includes details such as the group's name, description, associated business hour ID, escalation agent ID, unassigned duration, list of agent IDs, auto ticket assignment status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Job

ID: get_view_a_job
Operation: read
Entities: job
Summary: The 'View a Job' API endpoint allows users to retrieve details of a specific job by its unique identifier. The request requires basic authentication using an API key. The job ID must be provided as a path parameter. The response includes details such as the job's name, status, creation and update timestamps, and progress percentage.
Input Fields: Input Fields
Output Fields: Output Fields

View a Product

ID: get_view_a_product
Operation: read
Entities: product
Summary: The 'View a Product' API allows users to retrieve details of a specific product by its unique identifier. The request requires basic authentication using an API key in the headers. The path parameter 'id' is mandatory and specifies the product to be retrieved. The response includes the product's id, name, description, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Role

ID: get_view_a_role
Operation: read
Entities: role
Summary: The 'View a Role' API endpoint allows users to retrieve details of a specific role by its unique identifier. The request requires basic authentication using an API key in the headers. The role ID must be provided as a path parameter. The response includes the role's ID, name, description, whether it is a default role, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Service Group

ID: get_view_a_service_group
Operation: read
Entities: service group, business hour, agent
Summary: The 'View a Service Group' API allows users to retrieve details of a specific service group by its ID. The request requires an API key for authentication, which should be included in the headers. The ID of the service group must be specified in the path parameters. The response includes details such as the group's name, description, escalation ID, unassigned duration, business hour ID, auto ticket assignment status, group type, creation and update timestamps, and a list of agent IDs associated with the group.
Input Fields: Input Fields
Output Fields: Output Fields

View a Service Task

ID: get_view_a_service_task
Operation: read
Entities: service task, custom field, ticket
Summary: The 'View a Service Task' API allows users to retrieve details of a specific service task by providing the ticket ID. The request requires an API key for authentication and the content type must be 'application/json'. The response includes detailed information about the service task such as priority, requester ID, status, subject, description, custom fields, and associated tickets. The API returns a comprehensive JSON object with all relevant details of the service task.
Input Fields: Input Fields
Output Fields: Output Fields

View a Skill

ID: get_view_a_skill
Operation: read
Entities: skill, condition, agent
Summary: The 'View a Skill' API endpoint allows users to retrieve detailed information about a specific skill by its ID. The request requires an API key for authentication, which should be included in the headers. The skill ID is a required path parameter. The response includes details such as the skill's name, rank, creation and update timestamps, associated agents, match type, and conditions. Conditions include resource type, field name, operator, value, and any nested fields.
Input Fields: Input Fields
Output Fields: Output Fields

View a Solution Article

ID: get_view_a_solution_article
Operation: read
Entities: solution article, category, folder
Summary: The 'View a Solution Article' API allows users to retrieve details of a solution article from the Freshdesk platform. The API requires an API key for authentication, which should be included in the headers. The path parameters include the 'id' of the solution article, which is required, and an optional 'language_code' to view the article in a specific language. If a language code is provided, metrics such as 'thumbs_up', 'thumbs_down', and 'hits' will be specific to that language. The response includes detailed information about the article, such as its ID, type, category, folder, hierarchy, metrics, tags, SEO data, agent ID, title, description, status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Solution Category

ID: get_view_a_solution_category
Operation: read
Entities: language, category, solution
Summary: The 'View a Solution Category' API allows users to retrieve details of a specific solution category by its unique identifier. The API supports optional language translation by providing a language code. The request requires an API key for authentication, passed in the headers. The response includes the category's ID, name, description, and timestamps for creation and last update. If a language code is provided, the category details are returned in the specified language.
Input Fields: Input Fields
Output Fields: Output Fields

View a Solution Folder

ID: get_view_a_solution_folder
Operation: read
Entities: category, solution, folder
Summary: The 'View a Solution Folder' API allows users to retrieve details of a specific solution folder by its ID. The API supports fetching translated folders by specifying a language code. The request requires basic authentication via an API key. The response includes details such as the folder's name, description, parent folder ID, hierarchy, article count, sub-folder count, visibility, category ID, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View a Ticket

ID: get_view_a_ticket
Operation: read
Entities: ticket, conversation, company
Summary: The 'View a Ticket' API allows users to retrieve detailed information about a specific ticket by its ID. The API supports embedding additional details such as conversations, requester, company, and stats, which consume additional API credits. The request requires an API key for authentication and supports optional query parameters to include additional details. The response includes comprehensive ticket information such as CC emails, priority, status, requester ID, company ID, creation and update timestamps, and more. The API also supports viewing ticket associations, identifying whether a ticket is a parent, child, tracker, or related ticket.
Input Fields: Input Fields
Output Fields: Output Fields

View a Ticket Field

ID: get_view_a_ticket_field
Operation: read
Entities: section, ticket field, choice
Summary: The 'View a Ticket Field' API allows you to retrieve details of a specific ticket field by its ID. The API requires an API key for authentication, which should be included in the headers. The 'id' of the ticket field is a required path parameter. Optionally, you can include additional data such as 'section' in the query parameters. The response includes detailed information about the ticket field, such as its name, label, type, position, and whether it is default or editable by customers. It also provides information about sections and choices associated with the ticket field.
Input Fields: Input Fields
Output Fields: Output Fields

View a Ticket Form

ID: get_view_a_ticket_form
Operation: read
Entities: portal, ticket form, field
Summary: The 'View a Ticket Form' API allows users to retrieve details of a specific ticket form by its ID. The request requires an API key for authentication, which should be included in the headers. The ID of the ticket form is specified as a path parameter. The response includes detailed information about the ticket form, such as its name, title, description, creation and update timestamps, and a list of fields associated with the form. Each field contains attributes like its name, label, type, and whether it is editable or required for various actions.
Input Fields: Input Fields
Output Fields: Output Fields

View A Ticket Form's Field

ID: get_view_a_ticket_forms_field
Operation: read
Entities: ticket form, field
Summary: The 'View A Ticket Form's Field' API allows users to retrieve details of a specific field within a ticket form. The API requires the form ID and field ID as path parameters and an API key for authentication in the headers. The response includes detailed information about the field, such as its ID, name, label, type, position, and various attributes indicating whether it is default, editable by customers, required for closure, and more. The response also provides timestamps for when the field was created and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

View a Topic

ID: get_view_a_topic
Operation: read
Entities: user, topic, forum
Summary: The 'View a Topic' API allows users to retrieve details of a specific discussion topic by its ID. The request requires basic authentication using an API key. The topic ID must be provided as a path parameter. The response includes detailed information about the topic, such as its title, forum ID, user ID, lock status, publication status, number of posts, views, votes, and timestamps for creation, last update, and last reply.
Input Fields: Input Fields
Output Fields: Output Fields

View Account

ID: get_view_account
Operation: read
Entities: account, agent, organization
Summary: The View Account API allows users to retrieve detailed information about their Freshdesk account. The request requires basic authentication using an API key. The response includes details such as organisation ID, account name, domain, HIPAA compliance status, agent counts, timezone, data center location, tier type, address, and contact person information.
Input Fields: Input Fields
Output Fields: Output Fields

View all Satisfaction Ratings

ID: get_view_all_satisfaction_ratings
Operation: read
Entities: survey, satisfaction rating, user
Summary: The 'View all Satisfaction Ratings' API allows users to retrieve satisfaction ratings from surveys. Users can apply filters to view specific ratings based on criteria such as 'created_since' and 'user_id'. The API requires an API key for authentication, passed in the headers. The response includes details such as the rating ID, survey ID, user ID, agent ID, feedback, ticket ID, and the ratings given. The response is in JSON format and includes timestamps for when the ratings were created and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

View an Agent

ID: get_view_an_agent
Operation: read
Entities: agent, contact, role
Summary: The 'View an Agent' API allows you to retrieve detailed information about a specific agent using their unique identifier. The request requires an API key for authentication, which should be included in the headers. The agent's ID is specified as a path parameter. The response includes various details about the agent such as availability, roles, skills, and contact information. The contact information includes email, job title, language, and time zone among other details.
Input Fields: Input Fields
Output Fields: Output Fields

View an Archive Ticket

ID: get_view_an_archive_ticket
Operation: read
Entities: response, ticket, field
Summary: The 'View an Archive Ticket' API allows users to retrieve details of an archived ticket using its ID. The request requires an API key for authentication and the content type must be 'application/json'. The ticket ID is specified as a path parameter. The response includes detailed information about the ticket such as CC emails, priority, requester ID, status, subject, creation and update timestamps, custom fields, and whether the ticket is archived. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

View an Automation Rule

ID: get_view_an_automation_rule
Operation: read
Entities: condition, automation rule, event
Summary: The 'View an Automation Rule' API allows users to retrieve details of a specific automation rule by its ID and automation type ID. The request requires an API key for authentication and the 'Content-Type' header set to 'application/json'. The path parameters include 'automation_type_id' and 'id', which are required to specify the type and ID of the automation rule. The response includes detailed information about the automation rule, such as its name, position, active status, performer details, events, conditions, actions, and metadata like creation and update timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

View an Email Config

ID: get_view_an_email_config
Operation: read
Entities: email config
Summary: The 'View an Email Config' API endpoint allows users to retrieve details of a specific email configuration by its ID. The request requires basic authentication using an API key in the headers. The ID of the email configuration must be provided as a path parameter. The response includes details such as the name, associated product ID, email addresses, group ID, primary role status, active status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

View Automatic Bcc Emails

ID: get_view_automatic_bcc_emails
Operation: read
Entities: email, notification
Summary: The 'View Automatic Bcc Emails' API allows users to retrieve a list of email addresses that are automatically Bcc'd in notifications. The request requires basic authentication using an API key and the 'Content-Type' header set to 'application/json'. The response returns a JSON object containing an array of email addresses.
Input Fields: Input Fields
Output Fields: Output Fields

View a contact field

ID: get_view_contact_field
Operation: read
Entities: contact field
Summary: The 'View a contact field' API allows you to retrieve details of a specific contact field by its ID. The request requires an API key for authentication, which should be included in the headers. The ID of the contact field must be specified in the path parameters. The response includes detailed information about the contact field, such as its name, label, type, position, and whether it is required for agents or customers. It also includes metadata like creation and update timestamps, and any choices available for dropdown fields.
Input Fields: Input Fields
Output Fields: Output Fields

View an Email Mailbox

ID: get_view_email_mailbox
Operation: read
Entities: email mailbox, product, custom mailbox
Summary: The 'View an Email Mailbox' API allows users to retrieve details of a specific email mailbox by its unique identifier. The request requires an API key for authentication, which should be included in the headers. The 'id' of the mailbox must be specified in the path parameters. The response includes detailed information about the mailbox, such as its name, support email, group ID, and whether it is the default reply email. It also provides configuration details for both incoming and outgoing mail servers, including server addresses, ports, SSL usage, and authentication methods.
Input Fields: Input Fields
Output Fields: Output Fields

View Helpdesk Settings

ID: get_view_helpdesk_settings
Operation: read
Entities: portal, language, setting
Summary: The 'View Helpdesk Settings' API endpoint retrieves the current settings of the helpdesk, including the primary language, supported languages, and portal languages. The request requires basic authentication using an API key. The response includes the primary language of the helpdesk, a list of supported languages, and a list of portal languages.
Input Fields: Input Fields
Output Fields: Output Fields

View Mailbox Settings

ID: get_view_mailbox_settings
Operation: read
Entities: email, mailbox setting, conversation
Summary: The 'View Mailbox Settings' API endpoint allows users to retrieve the current settings of their mailbox in Freshdesk. This API uses a GET request to the '/api/v2/email/settings' endpoint. The request requires basic authentication using an API key and the 'Content-Type' header set to 'application/json'. The response includes settings such as whether personalized email replies are enabled, if a requester is created using the reply-to address, if agents are allowed to initiate conversations, and if the original sender is set as the requester for forwarded emails.
Input Fields: Input Fields
Output Fields: Output Fields

Add or Remove Agents in a Group

ID: patch_add_or_remove_agents_in_a_group
Operation: write
Entities: agent, group
Summary: The 'Add or Remove Agents in a Group' API allows you to modify the agents associated with a specific group in Freshdesk. You can add agents by providing their IDs or remove them by setting the 'deleted' flag to true. The API requires the group ID as a path parameter and the list of agents in the request body. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The response returns a 204 No Content status, indicating the operation was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Update Ticket User Access

ID: patch_update_ticket_user_access
Operation: write
Entities: ticket, user
Summary: The Update Ticket User Access API allows you to modify the access permissions of users for a specific ticket. You can specify an array of user objects, each containing a user ID and an optional 'deleted' flag to indicate if the user's access should be removed. The API requires authentication via an API key and the ticket ID as a path parameter. The response returns an array of user IDs that currently have access to the ticket.
Input Fields: Input Fields
Output Fields: Output Fields

Add Ticket User Access

ID: post_add_ticket_user_access
Operation: write
Entities: ticket, access, user
Summary: The 'Add Ticket User Access' API allows you to grant access to a specific ticket for a list of users. The API requires the ticket ID as a path parameter and a list of user IDs in the request body. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. Upon successful execution, the API returns a list of user IDs who have been granted access to the ticket.
Input Fields: Input Fields
Output Fields: Output Fields

Add watcher

ID: post_add_watcher
Operation: write
Entities: ticket, agent
Summary: The 'Add watcher' API allows you to add an agent as a watcher to a specific ticket. The API requires the ticket ID as a path parameter and the user ID of the agent to be added as a watcher in the request body. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. Upon successful execution, the API returns a 204 No Content status, indicating that the watcher was added successfully without returning any content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Create Canned Responses

ID: post_bulk_create_canned_responses
Operation: write
Entities: folder, group, canned response
Summary: The Bulk Create Canned Responses API allows users to create multiple canned responses in a single request. The request body must include an array of canned responses, each with a title, HTML content, and visibility setting. Optionally, a folder ID can be specified unless the visibility is set to 1. If visibility is set to 2, group IDs must be provided. Attachments can also be included, but the total size must not exceed 20MB. The API returns a job ID and a URL to check the status of the bulk operation.
Input Fields: Input Fields
Output Fields: Output Fields

Create A Comment

ID: post_create_a_comment
Operation: write
Entities: comment, topic, user
Summary: The 'Create A Comment' API allows users to add a comment to a specific discussion topic in Freshdesk. The API requires the topic ID as a path parameter and the comment content in HTML format as the body of the request. The request must include headers for content type and authorization. Upon successful creation, the API returns details of the comment, including its ID, content, associated topic and forum IDs, user ID, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Company

ID: post_create_a_company
Operation: write
Entities: domain, custom object, company
Summary: The 'Create a Company' API allows users to create a new company record in the system. It accepts various parameters such as 'name', 'domains', 'description', 'health_score', 'account_tier', 'renewal_date', 'industry', and 'lookup_parameter'. The 'custom_fields' parameter allows for additional custom data to be associated with the company. The API requires authentication via an API key and returns a JSON response containing the details of the newly created company, including its 'id', 'name', 'description', 'domains', 'health_score', 'account_tier', 'renewal_date', and any 'custom_fields' provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Contact

ID: post_create_a_contact
Operation: write
Entities: contact, custom field, company
Summary: The 'Create a Contact' API allows users to create a new contact in the system. It accepts various parameters such as name, email, phone, mobile, twitter_id, unique_external_id, other_emails, company_id, view_all_tickets, other_companies, address, avatar, custom_fields, description, job_title, language, tags, time_zone, and lookup_parameter. At least one of the attributes 'name', 'email', 'phone', or 'mobile' is mandatory. The API supports JSON and multipart/form-data content types, especially for uploading avatars. The response includes details about the created contact, such as active status, address, company associations, email, ID, job title, language, and more. The API also supports custom fields and tags for additional customization.
Input Fields: Input Fields
Output Fields: Output Fields

Create A Forum

ID: post_create_a_forum
Operation: write
Entities: category, company, forum
Summary: The 'Create A Forum' API allows users to create a new forum under a specified category. The API requires the category ID as a path parameter. The request body must include the forum's name, description, type, and visibility level. Optionally, if the visibility level is set to 4, an array of company IDs can be provided to restrict visibility to users from those companies. The API returns the details of the created forum, including its ID, name, description, position, category ID, type, visibility level, and counts of topics and posts.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Group

ID: post_create_a_group
Operation: write
Entities: ticket, agent, group
Summary: The 'Create a Group' API allows users to create a new group in the Freshdesk system. The API requires a POST request to the endpoint '/api/v2/groups'. The request must include a JSON body with the 'name' of the group as a required field. Optional fields include 'agent_ids' (an array of agent user IDs), 'auto_ticket_assign' (automatic ticket assignment type), 'description' (description of the group), 'escalate_to' (user ID for escalation emails), and 'unassigned_for' (time duration for escalation emails). The response returns a JSON object containing details of the created group, including its 'id', 'name', 'description', 'business_hour_id', 'escalate_to', 'unassigned_for', 'agent_ids', 'auto_ticket_assign', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Note

ID: post_create_a_note
Operation: write
Entities: attachment, ticket, note
Summary: The 'Create a Note' API allows users to add a note to a specific ticket in the system. The note can be private or public, and can include attachments. The request requires the ticket ID as a path parameter and the note content as part of the request body. Optional parameters include attachments, incoming status, notification emails, and the user ID of the note creator. The response includes details of the created note, such as its ID, content, privacy status, and any associated attachments.
Input Fields: Input Fields
Output Fields: Output Fields

Create A Record

ID: post_create_a_record
Operation: write
Entities: record, custom object, field
Summary: The Create A Record API allows you to create a new record in a specified schema. The request requires authentication via an API key and the content type must be 'application/json'. The schema ID must be specified in the path parameters. The request body should contain the data for the record, including fields such as 'customer_id', 'customer_name', and 'age'. The response includes the display ID of the created record, timestamps for creation and last update, and the data of the created record.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Reply

ID: post_create_a_reply
Operation: write
Entities: attachment, ticket, reply
Summary: The 'Create a Reply' API allows users to add a reply to a specific ticket in the Freshdesk system. The API requires the ticket ID as a path parameter and accepts a JSON body containing the reply content in HTML format. Optional fields include attachments, the sender's email, the agent's user ID, and email addresses for CC and BCC. The response includes details of the reply such as its ID, content, associated ticket ID, and any attachments. The API supports both JSON and multipart/form-data content types, with the latter being necessary for including attachments.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Section

ID: post_create_a_section
Operation: write
Entities: ticket field, section
Summary: The 'Create a Section' API allows users to create a new section under a specified ticket field in the system. The API requires the ticket field ID as a path parameter and accepts a JSON body containing the 'label' and 'choice_ids' to define the section. The 'label' is a string representing the display name of the section, and 'choice_ids' is an array of numbers indicating the choices for which the section should be displayed. The API returns a list of sections with details such as section ID, label, parent ticket field ID, choice IDs, ticket field IDs, and a boolean indicating if the section is FSM.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Service Task

ID: post_create_a_service_task
Operation: write
Entities: parameter, ticket, custom field
Summary: The Create a Service Task API allows users to create a new service task ticket in the system. This API requires authentication via an API key and accepts a JSON payload with details about the service task, including the parent ticket ID, type, subject, description, status, priority, requester ID, and optional custom fields such as contact name, phone number, service location, and appointment times. The response includes details of the created ticket, such as its ID, subject, description, status, priority, requester ID, and custom fields, along with metadata like creation and update timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Skill

ID: post_create_a_skill
Operation: write
Entities: condition, agent, skill
Summary: The Create a Skill API allows you to create a new skill in the system. You need to provide the name of the skill, an array of agent user IDs, the match type for conditions, and an array of conditions. Each condition includes a resource type, field name, operator, value, and optional nested fields for dependent conditions. The API returns the details of the created skill, including its ID, creation and update timestamps, name, agents, match type, conditions, and rank.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Solution Folder

ID: post_create_a_solution_folder
Operation: write
Entities: solution folder, language, company
Summary: The 'Create a Solution Folder' API allows users to create a new solution folder in a specified language. The API requires the folder ID and language code as path parameters. The request body must include the name and description of the folder, and optionally, the parent folder ID, visibility, and IDs of companies, contact segments, and company segments for visibility settings. The response includes details of the created folder, such as its ID, name, description, hierarchy, article count, sub-folder count, visibility, category ID, and timestamps for creation and last update. This API is useful for organizing solutions in a multilingual helpdesk environment.
Input Fields: Input Fields
Output Fields: Output Fields

Create a thread

ID: post_create_a_thread
Operation: write
Entities: ticket, participant, thread
Summary: The 'Create a thread' API allows users to create a new thread in the collaboration section. The request requires a POST method to the endpoint 'https://domain.freshdesk.com/api/v2/collaboration/threads'. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' header with the API key. The body of the request must include the 'type' of the thread, the 'parent' object with its 'id' and 'type', and 'additional_info' with 'email_config_id'. The response returns an array of thread objects, each containing details such as 'id', 'type', 'created_by', 'parent', 'participants', 'linked_object', 'created_at', 'updated_at', 'additional_info', 'is_read', and 'updated_by'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Ticket

ID: post_create_a_ticket
Operation: write
Entities: attachment, ticket, object
Summary: The Create a Ticket API allows users to create a new support ticket in the Freshdesk system. The API accepts various parameters such as description, subject, email, priority, status, and optional fields like cc_emails, custom_fields, lookup_parameter, attachments, parent_id, and related_ticket_ids. The request can be made with 'application/json' or 'multipart/form-data' content types, depending on whether attachments are included. The response includes details of the created ticket, such as its ID, subject, status, priority, associated emails, and any custom fields or attachments. This API supports creating standard tickets, tickets with custom fields, tickets associated with custom object records, tickets with attachments, child tickets, and tracker tickets.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Ticket Field

ID: post_create_a_ticket_field
Operation: write
Entities: ticket field, customer, agent
Summary: The 'Create a Ticket Field' API allows users to create a new ticket field in the system. The API accepts various parameters in the request body, such as 'customers_can_edit', 'label_for_customers', 'displayed_to_customers', 'label', 'type', 'position', 'required_for_closure', 'required_for_agents', 'required_for_customers', 'choices', 'dependent_fields', and 'section_mappings'. These parameters define the properties and behavior of the ticket field. The API returns a response containing details of the created ticket field, including its 'id', 'name', 'label', 'position', 'type', 'choices', and other attributes. The API is accessed via a POST request to the specified URL with the appropriate headers and body.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Ticket Form

ID: post_create_a_ticket_form
Operation: write
Entities: requester, field, ticket form
Summary: The 'Create a Ticket Form' API allows users to create a new ticket form in the system. The API requires a POST request to the endpoint 'https://domain.freshdesk.com/api/v2/ticket-forms' with a JSON body containing the 'title', 'description', and 'fields' of the form. The 'fields' parameter is an array of objects, each representing a field in the form with attributes like 'id', 'label_for_customers', 'customers_can_edit', 'required_for_customers', etc. The API requires 'Content-Type' and 'Authorization' headers for authentication. The response includes details of the created ticket form, such as 'id', 'name', 'title', 'description', 'created_at', 'updated_at', and 'fields'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Topic

ID: post_create_a_topic
Operation: write
Entities: topic, post, forum
Summary: The 'Create a Topic' API allows users to create a new discussion topic within a specified forum. The API requires the forum ID as a path parameter and accepts a JSON body containing the topic's title and message. Optional parameters include 'locked' to prevent further posts, 'sticky' to keep the topic at the top of the forum, and 'stamp_type' for categorization. The API requires authentication via an API key in the headers. Upon successful creation, the API returns the details of the created topic, including its ID, title, forum ID, user ID, and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Agent

ID: post_create_an_agent
Operation: write
Entities: agent, role, group
Summary: The 'Create an Agent' API allows you to create a new agent in the system. You can specify various attributes for the agent such as email, name, ticket scope, occasional status, language, group IDs, role IDs, skill IDs, agent type, and focus mode. The API requires the 'Content-Type' header to be set to 'application/json'. The request body must include the 'email', 'ticket_scope', and 'role_ids' fields as they are mandatory. The response includes details about the created agent, such as their availability, occasional status, ID, ticket scope, signature, associated group, role, and skill IDs, creation and update timestamps, type, contact details, and focus mode status.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Automation Rule

ID: post_create_automation_rule
Operation: write
Entities: action, automation rule, condition
Summary: The Create an Automation Rule API allows users to create a new automation rule in the system. The API requires the 'automation_type_id' as a path parameter to specify the type of automation. The request body must include details such as the 'name', 'position', 'active' status, 'performer', 'events', 'conditions', and 'actions' for the rule. The 'performer' specifies who triggers the rule, 'events' define what triggers the rule, 'conditions' specify when the rule should run, and 'actions' define what the rule does. The response includes the created rule's details, including its 'id', 'name', 'position', 'active' status, and a summary of the rule's configuration.
Input Fields: Input Fields
Output Fields: Output Fields

Create a canned response

ID: post_create_canned_response
Operation: write
Entities: folder, agent, canned response
Summary: The 'Create a canned response' API allows users to create a new canned response in the system. The request requires a title, HTML content, folder ID, and visibility setting. Optionally, group IDs and attachments can be included if the visibility is set to 2. The response returns the details of the created canned response, including its ID, title, folder ID, content, HTML content, attachments, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a company field

ID: post_create_company_field
Operation: write
Entities: choice, position, company field
Summary: The 'Create a company field' API allows users to create a new custom field for a company. The request requires a label, type, and position for the field. Optionally, the field can be marked as required for agents, and choices can be provided if the field type is a dropdown. The response returns the details of the created field, including its ID, name, label, position, and choices if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Create a contact field

ID: post_create_contact_field
Operation: write
Entities: contact field, agent, customer
Summary: The 'Create a contact field' API allows users to create a new contact field in the system. The API requires a POST request to the endpoint '/api/v2/contact_fields' with a JSON body containing details about the contact field such as 'label', 'label_for_customers', 'type', and other optional parameters like 'editable_in_signup', 'position', 'required_for_agents', etc. The API also supports dropdown fields with 'choices' parameter. The response includes details of the created contact field, including its 'id', 'name', 'label', 'type', and 'choices'.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Email Mailbox

ID: post_create_email_mailbox
Operation: write
Entities: product, email mailbox, group
Summary: The 'Create an Email Mailbox' API allows users to create a new email mailbox in the Freshdesk system. The API accepts various parameters such as 'name', 'support_email', 'group_id', 'product_id', 'default_reply_email', and 'mailbox_type'. If the 'mailbox_type' is 'custom_mailbox', additional configurations for incoming and outgoing mail servers are required. The API returns details of the created mailbox, including its ID, name, support email, and configuration details.
Input Fields: Input Fields
Output Fields: Output Fields

Create Folder

ID: post_create_folder
Operation: write
Entities: folder, canned response
Summary: The Create Folder API allows users to create a new folder in the canned response section. It requires a POST request to the specified endpoint with a JSON body containing the 'name' of the folder. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with the API key. Upon successful creation, the API returns a JSON response with the 'Id' and 'name' of the newly created folder.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Forum Category

ID: post_create_forum_category
Operation: write
Entities: category, forum
Summary: The 'Create a Forum Category' API allows users to create a new forum category in the discussion forum. It requires a POST request to the endpoint '/api/v2/discussions/categories' with a JSON body containing the 'name' and 'description' of the category. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with the API key. The response returns a JSON object with details of the created category, including its 'id', 'name', 'description', 'created_at', and 'updated_at' timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Create message for thread

ID: post_create_message_for_thread
Operation: write
Entities: message, participant, thread
Summary: The 'Create message for thread' API allows users to create a new message within a specified thread. The API requires a POST request to the endpoint 'https://domain.freshdesk.com/api/v2/collaboration/messages' with a JSON body containing the message content, participants, additional information, thread ID, and optional attachment IDs. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' header with the API key. The response includes details of the created message such as its ID, content, participants, creation timestamps, and additional information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Multiple Agents

ID: post_create_multiple_agents
Operation: write
Entities: agent, role, group
Summary: The 'Create Multiple Agents' API allows the creation of multiple agents in a single request. The request requires authentication via an API key and must include a JSON body with an array of agent objects. Each agent object can include details such as email, name, ticket scope, occasional status, language, group IDs, role IDs, and skill IDs. The response returns a job ID and a URL to check the status of the job.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Outbound Email

ID: post_create_outbound_email
Operation: write
Entities: email, ticket, agent
Summary: The 'Create an Outbound Email' API allows users to create a new outbound email ticket in the system. By default, the ticket is assigned to the agent sending the email and is created with a 'closed' status to prevent unnecessary SLA timers. The API requires a JSON body with details such as 'description', 'subject', 'email', 'priority', 'email_config_id', and optional 'cc_emails'. The response includes details of the created ticket, such as 'cc_emails', 'priority', 'requester_id', 'status', 'subject', and timestamps for creation and updates. Note that the subject and description of outbound tickets cannot be updated after creation.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Satisfaction Rating

ID: post_create_satisfaction_rating
Operation: write
Entities: survey, satisfaction rating, ticket
Summary: The 'Create a Satisfaction Rating' API allows users to submit feedback and ratings for a specific ticket. The API requires the ticket ID as a path parameter and accepts a JSON body containing feedback and ratings. The feedback is a string, and ratings are provided as key/value pairs where the key is the question ID and the value is the rating. The response includes details such as the survey ID, user ID, agent ID, feedback, ticket ID, ratings, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Service Group

ID: post_create_service_group
Operation: write
Entities: service group, agent, group type
Summary: The Create a Service Group API allows users to create a new service group in the system. The request requires a JSON body with the 'name', 'description', 'agent_ids', and 'group_type' fields. The 'group_type' must be 'field_agent_group'. The API key must be provided in the Authorization header. The response includes details of the created group, such as its ID, name, description, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create SLA Policies

ID: post_create_sla_policies
Operation: write
Entities: sla policy, escalation, priority
Summary: The Create SLA Policies API allows users to create new SLA policies in the system. It requires a POST request to the endpoint '/api/v2/sla_policies' with a JSON body containing details such as the name, description, active status, default status, position, SLA targets, applicable conditions, and escalation details. The response includes the created SLA policy's ID, name, description, active status, default status, position, SLA targets, applicable conditions, escalation details, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Solution Article

ID: post_create_solution_article
Operation: write
Entities: solution article, category, folder
Summary: The 'Create a Solution Article' API allows users to create a new solution article or a translated version of an existing article in a specified language. The API requires the article ID and language code as path parameters. The request body must include the title, description, and status of the article. Optional fields include SEO data and tags. The response includes details of the created article, such as its ID, title, description, status, and hierarchy information. The API requires authentication via an API key.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Solution Category

ID: post_create_solution_category
Operation: write
Entities: portal, language, solution category
Summary: The 'Create a Solution Category' API allows users to create a new solution category or a translated version of an existing category in a specified language. The API requires the 'id' of the category and the 'language_code' for translation as path parameters. The request body must include the 'name' and 'description' of the category, and optionally, a list of 'visible_in_portals' IDs. The API key must be provided in the headers for authentication. The response includes the 'id', 'name', 'description', 'created_at', and 'updated_at' timestamps of the created category. Note that the multilingual feature must be enabled, and supported languages configured in the Helpdesk settings.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Time Entry

ID: post_create_time_entry
Operation: write
Entities: ticket, agent, time entry
Summary: The 'Create a Time Entry' API allows users to create a time entry for a specific ticket. The API requires the ticket ID as a path parameter and accepts various optional fields in the request body, such as agent_id, billable, executed_at, note, start_time, time_spent, and timer_running. The API automatically sets the timer_running attribute to true if time_spent or start_time is specified and timer_running is not. The response includes details of the created time entry, such as its ID, billable status, note, timer status, associated agent and ticket IDs, time spent, and timestamps for creation, update, start, and execution.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Multiple Tickets

ID: post_delete_multiple_tickets
Operation: write
Entities: job, ticket
Summary: The Delete Multiple Tickets API allows users to delete multiple tickets in bulk by specifying their IDs. The request requires an API key for authentication and must include the 'Content-Type' header set to 'application/json'. The body of the request should contain a 'bulk_action' object with an 'ids' array listing the ticket IDs to be deleted. Upon successful request, the API returns a job ID and a URL to check the status of the deletion job. The response includes the job ID, a link to check the job status, and the current status of the job.
Input Fields: Input Fields
Output Fields: Output Fields

Export Account

ID: post_export_account
Operation: write
Entities: account, resource, export
Summary: The Export Account API allows an account admin to export account data based on specified criteria such as date range, resources, and export format. The request requires authentication via an API key and includes headers for content type and authorization. The body of the request must specify the date range, resources to include, and the desired output format. The response provides details of the export job, including a job ID and a link to check the status of the export.
Input Fields: Input Fields
Output Fields: Output Fields

Forward a Ticket

ID: post_forward_a_ticket
Operation: write
Entities: email, ticket, agent
Summary: The 'Forward a Ticket' API allows users to forward a ticket to an external email address. The API requires the ticket ID as a path parameter and accepts various optional fields in the request body, such as 'body', 'body_text', 'agent_id', 'support_email', 'source', 'ticket_id', 'include_quoted_text', 'include_original_attachments', 'from_email', 'to_emails', 'cc_emails', and 'bcc_emails'. The response includes details of the forwarded note, such as 'body', 'body_text', 'id', 'incoming', 'private', 'user_id', 'support_email', 'source', 'category', 'ticket_id', 'to_emails', 'from_email', 'cc_emails', 'bcc_emails', 'email_failure_count', 'outgoing_failures', 'created_at', 'updated_at', 'attachments', 'deleted', 'last_edited_at', 'last_edited_user_id', 'cloud_files', and 'has_quoted_text'.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Contacts

ID: post_merge_contacts
Operation: write
Entities: contact, attribute, company
Summary: The Merge Contacts API is used to merge two or more duplicate contacts into a single contact. The API requires the ID of the primary contact and an array of IDs for the secondary contacts to be merged. Optionally, a 'contact' object can be provided to update attributes in the primary contact during the merge. The 'contact' object can include fields such as email, phone, mobile, twitter_id, unique_external_id, other_emails, and company_ids. The API requires an API key for authentication and expects the request body to be in JSON format. Upon successful merging, the API returns a 204 No Content response, indicating that the operation was successful and there is no additional content to send in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Monitor Forum

ID: post_monitor_forum
Operation: write
Entities: discussion, user, forum
Summary: The Monitor Forum API allows a user to follow a specific forum by sending a POST request to the endpoint '/api/v2/discussions/forums/[id]/follow'. The request requires authentication via an API key and accepts a 'user_id' in the body to specify which user should follow the forum. If 'user_id' is not provided, the user associated with the API key will be used. The response is a 204 No Content status, indicating the request was successful but there is no content to return.
Input Fields: Input Fields
Output Fields: Output Fields

Monitor Topic

ID: post_monitor_topic
Operation: write
Entities: discussion, topic, user
Summary: The Monitor Topic API allows a user to follow a specific discussion topic in a forum. The API requires the topic ID as a path parameter and optionally accepts a user ID in the request body to specify which user should follow the topic. If the user ID is not provided, the user associated with the API key will be considered the follower. The request must include the 'Content-Type' and 'Authorization' headers. A successful request returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Publish Activities

ID: post_publish_activities
Operation: write
Entities: activity, contact, actor
Summary: The Publish Activities API allows you to publish activities that have occurred in an external application to Freshdesk. It requires a POST request to the endpoint '/api/v2/contact-activities' with a JSON body containing details of the activity and the contact. The activity object includes details such as the name, timestamp, description, actor, source, object, and context of the activity. The contact object includes identifying information such as email, twitter_id, unique_external_id, facebook_id, id, name, and is_actor. The API returns a success response with HTTP status 200 upon successful publishing of the activity.
Input Fields: Input Fields
Output Fields: Output Fields

Reply to Forward

ID: post_reply_to_forward
Operation: write
Entities: email, agent, note
Summary: The 'Reply to Forward' API allows users to reply to a forwarded email within a ticket. The API requires the ticket ID as a path parameter and accepts a JSON body containing the HTML content of the note, plain text content, user ID of the agent replying, and the list of recipient email addresses. The response includes details of the reply such as its ID, content in HTML and plain text, user ID of the agent, support email, and other metadata like creation and update timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Update Multiple Tickets

ID: post_update_multiple_tickets
Operation: write
Entities: ticket, agent, group
Summary: The 'Update Multiple Tickets' API allows users to update multiple tickets in bulk. The API requires a POST request to the endpoint '/api/v2/tickets/bulk_update'. The request body must include a 'bulk_action' object containing the 'ids' of the tickets to be updated and 'properties' to specify the updates such as 'from_email', 'status', 'group_id', 'type', and 'priority'. Additionally, a 'reply' object can be included to add a reply to the tickets. The response returns a 'job_id' and 'href' to check the status of the bulk update job.
Input Fields: Input Fields
Output Fields: Output Fields

Update A Ticket Form's Field

ID: post_update_ticket_form_field
Operation: write
Entities: ticket form, customer, field
Summary: The 'Update A Ticket Form's Field' API allows users to edit the contents of a ticket form field. The API requires the form-id and field-id as path parameters. The request body can include parameters such as 'label_for_customers', 'customers_can_edit', 'required_for_customers', 'hint_for_customers', 'placeholder_for_customers', and 'position' to update the field's attributes. The response returns the updated field details including 'id', 'name', 'label', 'position', 'type', and other attributes indicating the field's properties and status.
Input Fields: Input Fields
Output Fields: Output Fields

Add watcher to multiple tickets

ID: put_add_watcher_to_multiple_tickets
Operation: write
Entities: watcher, ticket, agent
Summary: The 'Add watcher to multiple tickets' API allows you to add a specified agent as a watcher to multiple tickets at once. The request requires the ticket IDs and the user ID of the agent to be added as a watcher. The request is authenticated using an API key. The response returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel a Company Import

ID: put_cancel_company_import
Operation: write
Entities: company import, import file, company
Summary: The 'Cancel a Company Import' API is used to cancel an ongoing company import job in Freshdesk. This API requires the import ID as a path parameter and uses the PUT method. Upon successful cancellation, it returns the import ID, creation timestamp, status (which will be 'cancelled'), total records, completed records, and details of any failures including a count and a URL to the failure report. The request must include an API key for authentication in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel a Contact Import

ID: put_cancel_contact_import
Operation: write
Entities: import, file, contact
Summary: The 'Cancel a Contact Import' API is used to cancel an ongoing contact import job in Freshdesk. This API requires the ID of the import job to be specified in the URL path. The request must include an API key for authentication and the content type should be 'application/json'. Upon successful cancellation, the API returns details of the import including its ID, creation timestamp, status (which will be 'cancelled'), total records, completed records, and any failures with a report URL.
Input Fields: Input Fields
Output Fields: Output Fields

Make Agent

ID: put_make_agent
Operation: write
Entities: agent, contact, role
Summary: The Make Agent API is used to convert a contact into an agent in the system. The contact must have an email address to be eligible for conversion. If the contact has 'other_emails', they will be deleted after conversion. The API requires authorization and the agent making the call must have the necessary permissions. The request can specify various parameters such as 'occasional', 'signature', 'ticket_scope', 'skill_ids', 'group_ids', 'role_ids', 'type', and 'focus_mode' to define the properties of the agent. If no request payload is provided, the contact will be converted to a full-time agent with global ticket scope and the role of a Support Agent. The response includes details about the newly created agent, such as their availability, type, role IDs, and ticket scope.
Input Fields: Input Fields
Output Fields: Output Fields

Make Field Technician

ID: put_make_field_technician
Operation: write
Entities: field technician, contact, license
Summary: The Make Field Technician API is used to convert a contact into a field technician. The API requires the contact ID as a path parameter and a JSON body specifying the type as 'field_agent', occasional status as false, and lists of group and role IDs. The request must include headers for content type and authorization. The response includes details about the contact and the newly created agent, such as their availability, group and role IDs, and ticket scope. The agent can only have 'Group access (2)' or 'Restricted access (3)' for the ticket_scope parameter, with the default being 'Restricted access (3)'. Sufficient field technician licenses are required to perform this operation.
Input Fields: Input Fields
Output Fields: Output Fields

Remove watcher from multiple tickets

ID: put_remove_watcher_from_multiple_tickets
Operation: write
Entities: ticket, watcher, user
Summary: The 'Remove watcher from multiple tickets' API allows the current logged-in user to remove themselves as a watcher from multiple tickets in bulk. The API requires the IDs of the tickets from which the watcher should be removed. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the user's API key. The request body should contain an array of ticket IDs. The API responds with a 204 No Content status code, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Remove watcher from ticket

ID: put_remove_watcher_from_ticket
Operation: write
Entities: api key, ticket, watcher
Summary: The 'Remove watcher from ticket' API allows you to remove a watcher from a specific ticket in the Freshdesk system. This is done by sending a PUT request to the endpoint '/api/v2/tickets/[id]/unwatch', where '[id]' is the ID of the ticket. The request must include an 'Authorization' header with the API key for authentication. The response will have an HTTP status of 204 No Content, indicating that the watcher was successfully removed and there is no additional content in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a Contact

ID: put_restore_a_contact
Operation: write
Entities: contact
Summary: The 'Restore a Contact' API is used to restore contacts that have been soft-deleted from a Freshdesk account. This API requires a PUT request to the endpoint 'https://domain.freshdesk.com/api/v2/contacts/[id]/restore', where '[id]' is the ID of the contact to be restored. The request must include an 'Authorization' header with a basic authentication token in the format 'yourapikey:X'. The API does not require a request body or query parameters. Upon successful restoration, the API returns a 204 No Content HTTP status, indicating that the contact has been restored successfully. Note that the agent's name, phone, mobile number, and job title cannot be updated using this API; these fields can only be updated from the Neo Admin Center.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a Ticket

ID: put_restore_a_ticket
Operation: write
Entities: ticket
Summary: The 'Restore a Ticket' API allows users to restore a previously deleted ticket in the Freshdesk system. The request requires the ticket ID as a path parameter and uses the PUT method. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' header with the API key. The response returns a 204 No Content status, indicating that the ticket has been successfully restored.
Input Fields: Input Fields
Output Fields: Output Fields

Send Invite to a Contact

ID: put_send_invite_to_a_contact
Operation: write
Entities: ticket, contact, knowledge base article
Summary: The 'Send Invite to a Contact' API is used to send an activation email to an existing contact for email verification. This allows the contact to log in to the customer portal using their password and check the status of their tickets. They can also access knowledge base articles or forums available only to logged-in users. The API requires the contact's ID as a path parameter and an API key for authentication in the headers. The response is a 204 No Content status, indicating that the invite was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Start/Stop Timer

ID: put_start_stop_timer
Operation: write
Entities: timer, agent, time entry
Summary: The Start/Stop Timer API allows you to toggle the timer for a specific time entry identified by its ID. The API requires an API key for authentication and expects the Content-Type header to be set to application/json. The time_entry_id must be provided as a path parameter. The response includes details about the time entry such as its ID, whether it is billable, associated note, timer status, agent and ticket IDs, time spent, and timestamps for creation, update, start, and execution.
Input Fields: Input Fields
Output Fields: Output Fields

Ticket Merge API

ID: put_ticket_merge
Operation: write
Entities: ticket, recipient, note
Summary: The Ticket Merge API allows you to merge multiple tickets into a primary ticket to streamline communication and avoid conflicts. The API requires a PUT request to the endpoint with the primary ticket ID and a list of ticket IDs to be merged. Optional parameters include converting recipients to CC and adding a note to the primary ticket. The response returns a 204 No Content status indicating successful merging of tickets.
Input Fields: Input Fields
Output Fields: Output Fields

Update A Comment

ID: put_update_a_comment
Operation: write
Entities: discussion, comment, forum
Summary: The 'Update A Comment' API allows users to update the content of a comment in a discussion forum. The API requires the comment ID as a path parameter and the updated content in the request body. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The response includes the updated comment details such as the comment ID, body text, topic ID, forum ID, user ID, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Company

ID: put_update_a_company
Operation: write
Entities: domain, custom field, company
Summary: The 'Update a Company' API allows you to update the details of a company in the system. You can update various attributes such as the company's name, description, domains, account tier, industry, and custom fields. The API requires the company ID as a path parameter and supports updating fields like custom_fields, description, domains, name, note, health_score, account_tier, renewal_date, industry, and lookup_parameter. The response includes the updated company details, including the ID, name, description, domains, note, timestamps, health score, account tier, renewal date, industry, and any custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Contact

ID: put_update_a_contact
Operation: write
Entities: contact, custom field, company
Summary: The 'Update a Contact' API allows you to modify the details of an existing contact in the Freshdesk system. You can update various attributes such as name, email, phone, job title, and more. The API supports updating the contact's avatar and custom fields. The request must include the contact's unique ID in the URL path. The response returns the updated contact details, including the contact's ID, name, email, job title, and other associated information.
Input Fields: Input Fields
Output Fields: Output Fields