Skip to Content

Freshservice API

Freshservice API icon
Arcade Starter

Tools that enable LLMs to interact directly with the Freshservice API.

Author:Arcade
Version:3.0.0
Auth:No authentication required
214tools
214require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

FreshserviceApi provides a toolkit that enables seamless interaction with the Freshservice API, facilitating various operations for managing IT service requests. This toolkit empowers developers to automate and streamline service desk actions effectively.

Capabilities

  • Activate and manage Customer Satisfaction (CSAT) surveys.
  • Add, update, and delete tasks, notes, and details for tickets, projects, changes, and problems.
  • Retrieve comprehensive details for assets, vendors, agents, and requests.
  • Manage organizational structures by creating or deleting departments, agent groups, and solutions.
  • Effortlessly handle asset and project management with detailed tracking features.

Secrets

  • Securely manage API keys, tokens, and private keys, e.g., FRESHSERVICE_API_KEY, enhancing the integrity of API calls.

Available tools(214)

214 of 214
Tool nameDescriptionSecrets
Activates a CSAT Survey by its ID in Freshservice. Use this tool to activate a Customer Satisfaction (CSAT) Survey in Freshservice by providing the survey's ID.
2
Add a new component to an existing asset. Use this tool to add a new component for a specific asset in Freshservice. It should be called when you need to track additional components associated with an asset.
2
Add a new note to a problem in Freshservice. Use this tool to create and add a new note to an existing problem in Freshservice, helping track updates or relevant information.
2
Create a new note on a release in Freshservice. Use this tool to add a note to a specific release in Freshservice. It should be called when you need to document or update information about a release.
2
Log a new time entry for a specific release in Freshservice. This tool is used to create a new time entry on a release within the Freshservice platform. It should be called when there's a need to record the time spent on a release. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Add a new note to a Freshservice ticket. Use this tool to post a new note on a specific Freshservice ticket by providing the ticket ID. This is useful for updating ticket information, providing status updates, or adding additional details related to the ticket. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Archive an existing project in Freshservice. Use this tool to archive a project within Freshservice. This is useful for organizing and managing completed or inactive projects.
2
Convert an agent to a requester in Freshservice. Use this tool to convert an agent, identified by their ID, into a requester in Freshservice. This action is typically used when an agent no longer needs agent-level access.
2
Convert a requester to an agent in Freshservice. Use this tool to convert a Freshservice requester into an occasional agent with the SD Agent role. This action removes any existing group memberships from the requester.
2
Create a new Agent Group in Freshservice. This tool allows you to create a new Agent Group in Freshservice. Use it to organize and manage agents within your Freshservice account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new announcement in Freshservice. Use this tool to create a new announcement in Freshservice, ideal for disseminating information or updates within your service platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new asset type in Freshservice. Use this tool to create a new asset type in Freshservice when setting up or managing assets. It automates the process of defining asset categories in the system.
2
Create a new canned response folder in Freshservice. This tool creates a new canned response folder in Freshservice. Use it when you need to organize canned responses into a new folder within the Freshservice platform.
2
Create a new note on a change request in Freshservice. This tool creates a new note attached to a specific change request in Freshservice. It should be called when there's a need to append additional information or updates related to an ongoing change request.
2
Create a task on a change request in Freshservice. This tool creates a new task on a specified change request within Freshservice. It should be called when you need to add tasks to an ongoing change request to track specific actions or activities. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new child ticket on a Freshservice ticket. Use this tool to add a child ticket to an existing ticket in Freshservice. It is useful for managing ticket hierarchies and organizing support tasks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new CSAT survey in Freshservice. This tool is used to create a new Customer Satisfaction (CSAT) survey in Freshservice. Call this tool when you need to set up a survey to gather customer feedback. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a custom ticket source in Freshservice. Use this tool to create a custom ticket source within the Freshservice platform. Ideal for when you need to define new ticket origin types beyond the defaults provided.
2
Create a new agent in Freshservice. This tool allows you to create a new agent in Freshservice. Use it when you need to add a team member to your Freshservice account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new canned response in Freshservice. Use this tool to create a new canned response in a Freshservice account. It should be called when there is a need to automate the creation of standard replies to frequent inquiries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new Change request in Freshservice. Use this tool to initiate a new Change request within the Freshservice platform. This is typically called when a user wants to propose a change that needs to be tracked and managed through Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a time entry for a change request in Freshservice. Use this tool to log a new time entry associated with a specific change request in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new task on a problem in Freshservice. This tool creates a new task associated with a specific problem in the Freshservice system. Use it when you need to assign tasks to a problem for better issue management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new project in Freshservice. Use this tool to create a new project within the Freshservice platform. This is useful for managing tasks, timelines, and resources efficiently in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Create a new support ticket in Freshservice. Use this tool to generate a new support ticket in Freshservice, which is useful for tracking and managing customer support issues. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
2
Page 1 of 9(25 of 214)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

FreshserviceApi.ActivateCsatSurvey

Activates a CSAT Survey by its ID in Freshservice. Use this tool to activate a Customer Satisfaction (CSAT) Survey in Freshservice by providing the survey's ID.

Parameters

ParameterTypeReq.Description
csat_survey_idintegerRequiredThe integer ID of the CSAT survey to activate in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'activate-survey'.
#

FreshserviceApi.AddAssetComponent

Add a new component to an existing asset. Use this tool to add a new component for a specific asset in Freshservice. It should be called when you need to track additional components associated with an asset.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique identifier of the asset to which the new component will be added. This should be an integer value.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-asset-component'.
#

FreshserviceApi.AddNoteToProblem

Add a new note to a problem in Freshservice. Use this tool to create and add a new note to an existing problem in Freshservice, helping track updates or relevant information.

Parameters

ParameterTypeReq.Description
note_html_bodystringRequiredThe HTML formatted content of the note to be added to the problem.
problem_idintegerRequiredThe ID of the problem to which the note will be added.
note_body_textstringOptionalThe content of the note in plain text format to be added to the problem in Freshservice.
note_creation_datetimestringOptionalThe date and time when the note was created, formatted as a string.
note_creator_user_idintegerOptionalThe unique ID of the user creating the note. This identifies who is responsible for the note addition.
note_unique_idintegerOptionalThe unique ID to be assigned to the note, ensuring it is distinct within Freshservice.
note_updated_datetimestringOptionalThe date and time when the note was last updated. Use the format 'YYYY-MM-DDTHH:MM:SSZ'.
notification_email_addressesarray<string>OptionalA list of email addresses to notify about the note. Each address should be in string format.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-problem-note'.
#

FreshserviceApi.AddReleaseNote

Create a new note on a release in Freshservice. Use this tool to add a note to a specific release in Freshservice. It should be called when you need to document or update information about a release.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique ID of the release to which the note will be added.
note_body_htmlstringOptionalProvide the note content in HTML format for the release.
note_body_plain_textstringOptionalThe body of the release note in plain text format. Use this for non-HTML content.
note_creation_datetimestringOptionalSpecify the date and time when the note was created. Format: YYYY-MM-DDTHH:MM:SSZ (ISO 8601 standard).
note_creator_user_idintegerOptionalUnique ID of the user who created the note. This ID should correspond to the user in Freshservice responsible for the note's content.
note_unique_idintegerOptionalInteger representing the unique ID of the note to be created.
note_updated_atstringOptionalThe date and time when the note was last updated, in ISO 8601 format.
notification_email_addressesarray<string>OptionalArray of email addresses to notify about the note.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-release-note'.
#

FreshserviceApi.AddReleaseTimeEntry

Log a new time entry for a specific release in Freshservice. This tool is used to create a new time entry on a release within the Freshservice platform. It should be called when there's a need to record the time spent on a release. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
release_idintegerOptionalThe ID of the release for which a new time entry is to be created. This should be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-release-time-entry'.
#

FreshserviceApi.AddTicketNote

Add a new note to a Freshservice ticket. Use this tool to post a new note on a specific Freshservice ticket by providing the ticket ID. This is useful for updating ticket information, providing status updates, or adding additional details related to the ticket. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_id_to_add_noteintegerOptionalThe ID of the Freshservice ticket to which the note will be added. This ID is required to specify the particular ticket to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket-note'.
#

FreshserviceApi.ArchiveProject

Archive an existing project in Freshservice. Use this tool to archive a project within Freshservice. This is useful for organizing and managing completed or inactive projects.

Parameters

ParameterTypeReq.Description
project_idintegerRequiredThe unique integer ID of the project to archive in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'archive-project'.
#

FreshserviceApi.ConvertAgentToRequester

Convert an agent to a requester in Freshservice. Use this tool to convert an agent, identified by their ID, into a requester in Freshservice. This action is typically used when an agent no longer needs agent-level access.

Parameters

ParameterTypeReq.Description
agent_id_to_convertintegerRequiredThe unique ID of the agent to convert to a requester.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-agent'.
#

FreshserviceApi.ConvertRequesterToAgent

Convert a requester to an agent in Freshservice. Use this tool to convert a Freshservice requester into an occasional agent with the SD Agent role. This action removes any existing group memberships from the requester.

Parameters

ParameterTypeReq.Description
requester_id_to_convertintegerRequiredThe numeric ID of the requester to be converted into an agent.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'convert-requester-to-agent'.
#

FreshserviceApi.CreateAgentGroupFreshservice

Create a new Agent Group in Freshservice. This tool allows you to create a new Agent Group in Freshservice. Use it to organize and manage agents within your Freshservice account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-agent-group'.
#

FreshserviceApi.CreateAnnouncement

Create a new announcement in Freshservice. Use this tool to create a new announcement in Freshservice, ideal for disseminating information or updates within your service platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-announcement'.
#

FreshserviceApi.CreateAssetType

Create a new asset type in Freshservice. Use this tool to create a new asset type in Freshservice when setting up or managing assets. It automates the process of defining asset categories in the system.

Parameters

ParameterTypeReq.Description
asset_type_namestringRequiredThe name of the asset type to be created.
asset_description_htmlstringOptionalProvide a short description of the asset type in HTML format for styling.
asset_type_idintegerOptionalUnique identifier for the asset type to be created.
asset_type_plain_text_descriptionstringOptionalShort description of the asset type in plain text format without HTML tags.
parent_asset_type_identifierintegerOptionalUnique identifier of the parent asset type. Use this to specify a hierarchy when creating a new asset type.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-asset-type'.
#

FreshserviceApi.CreateCannedResponseFolder

Create a new canned response folder in Freshservice. This tool creates a new canned response folder in Freshservice. Use it when you need to organize canned responses into a new folder within the Freshservice platform.

Parameters

ParameterTypeReq.Description
folder_namestringRequiredThe name of the new canned response folder to be created in Freshservice.
canned_response_folder_idintegerOptionalUnique identifier for the canned response folder. It must be an integer value.
folder_created_atstringOptionalThe timestamp indicating when the folder was created, formatted as a string.
folder_typestringOptionalSpecifies the type of the canned response folder, indicating its purpose or categorization.
initial_responses_countintegerOptionalSpecify the initial number of responses in the new canned response folder, typically starting at 0.
updated_at_timestampstringOptionalThe timestamp of the last update to the folder in ISO 8601 format.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-canned-response-folder'.
#

FreshserviceApi.CreateChangeNote

Create a new note on a change request in Freshservice. This tool creates a new note attached to a specific change request in Freshservice. It should be called when there's a need to append additional information or updates related to an ongoing change request.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredID of the change request to which the new note will be added.
note_body_htmlstringRequiredThe body of the note in HTML format. Use this to format the note with HTML tags for styling.
note_body_plain_textstringOptionalThe content of the change note in plain text format.
note_creation_datetimestringOptionalThe date and time when the note was created, in ISO 8601 format (e.g., '2023-01-01T12:00:00Z').
note_last_updatedstringOptionalDate and time when the note was last updated, in ISO 8601 format.
note_unique_idintegerOptionalUnique identifier for the note being created. Must be an integer.
notification_email_addressesarray<string>OptionalList of email addresses to notify about the change note.
user_identifier_for_note_creatorintegerOptionalUnique ID of the user who created the note in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-change-note'.
#

FreshserviceApi.CreateChangeTask

Create a task on a change request in Freshservice. This tool creates a new task on a specified change request within Freshservice. It should be called when you need to add tasks to an ongoing change request to track specific actions or activities. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
change_request_idintegerOptionalID of the change request to add a task to. It should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-change-task'.
#

FreshserviceApi.CreateChildTicket

Create a new child ticket on a Freshservice ticket. Use this tool to add a child ticket to an existing ticket in Freshservice. It is useful for managing ticket hierarchies and organizing support tasks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
parent_ticket_idintegerOptionalID of the main ticket for which a child ticket will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-child-ticket'.
#

FreshserviceApi.CreateCsatSurvey

Create a new CSAT survey in Freshservice. This tool is used to create a new Customer Satisfaction (CSAT) survey in Freshservice. Call this tool when you need to set up a survey to gather customer feedback. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-survey'.
#

FreshserviceApi.CreateCustomTicketSource

Create a custom ticket source in Freshservice. Use this tool to create a custom ticket source within the Freshservice platform. Ideal for when you need to define new ticket origin types beyond the defaults provided.

Parameters

ParameterTypeReq.Description
source_namestringRequiredSpecify the name for the custom ticket source in Freshservice.
created_timestampstringOptionalThe timestamp when the source was created in Freshservice. Format: YYYY-MM-DDTHH:MM:SSZ.
is_visible_for_selectionbooleanOptionalTrue if the source value is visible for selection in Freshservice.
last_modified_timestampstringOptionalThe timestamp indicating when the custom ticket source was last modified. Expected in ISO 8601 format.
source_idintegerOptionalUnique identifier for the custom ticket source.
source_position_in_listintegerOptionalThe position of the custom ticket source in the source list. It determines where this source appears in the list of sources.
source_present_by_defaultbooleanOptionalSet to true if the source value is present by default in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket-field-source'.
#

FreshserviceApi.CreateFreshserviceAgent

Create a new agent in Freshservice. This tool allows you to create a new agent in Freshservice. Use it when you need to add a team member to your Freshservice account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-agent'.
#

FreshserviceApi.CreateFreshserviceCannedResponse

Create a new canned response in Freshservice. Use this tool to create a new canned response in a Freshservice account. It should be called when there is a need to automate the creation of standard replies to frequent inquiries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-canned-response'.
#

FreshserviceApi.CreateFreshserviceChangeRequest

Create a new Change request in Freshservice. Use this tool to initiate a new Change request within the Freshservice platform. This is typically called when a user wants to propose a change that needs to be tracked and managed through Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-change'.
#

FreshserviceApi.CreateFreshserviceChangeTimeEntry

Create a time entry for a change request in Freshservice. Use this tool to log a new time entry associated with a specific change request in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
change_request_idintegerOptionalThe unique identifier of the change request for which you want to create a time entry. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-change-time-entry'.
#

FreshserviceApi.CreateFreshserviceProblemTask

Create a new task on a problem in Freshservice. This tool creates a new task associated with a specific problem in the Freshservice system. Use it when you need to assign tasks to a problem for better issue management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
problem_identifierintegerOptionalID of the problem for which a new task will be created. It must be an integer representing the specific problem in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-problem-task'.
#

FreshserviceApi.CreateFreshserviceProject

Create a new project in Freshservice. Use this tool to create a new project within the Freshservice platform. This is useful for managing tasks, timelines, and resources efficiently in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-project'.
#

FreshserviceApi.CreateFreshserviceTicket

Create a new support ticket in Freshservice. Use this tool to generate a new support ticket in Freshservice, which is useful for tracking and managing customer support issues. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket'.
#

FreshserviceApi.CreateNewAsset

Create a new asset in Freshservice. Use this tool to add a new asset to the Freshservice system. Ideal for tracking and managing assets efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-asset'.
#

FreshserviceApi.CreateNewLocation

Create a new location in Freshservice. Use this tool to create a new location within the Freshservice platform. It should be called when there is a need to add a new geographical or organizational location to the service database.

Parameters

ParameterTypeReq.Description
location_namestringRequiredProvide the name of the new location to be created.
address_line_2stringOptionalThe second line of the address, typically for additional location details or suite numbers.
address_street_line_onestringOptionalFirst line of the street address for the new location in Freshservice.
city_namestringOptionalThe name of the city where the location is situated.
location_countrystringOptionalSpecify the country for the new location. This should be a valid country name.
location_unique_idintegerOptionalAn integer representing the unique ID of the location to be created in Freshservice.
location_zip_codestringOptionalProvide the Zip Code for the location to be created.
parent_location_idintegerOptionalThe unique identifier of the parent location if applicable. Use this to nest the new location under an existing one.
primary_contact_unique_idintegerOptionalUnique ID of the primary contact. This contact is a requester, and their details will be referenced for name, email, and phone number.
statestringOptionalThe state or region of the location. This should be a string value representing the official name of the state.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-location'.
#

FreshserviceApi.CreateNewProblem

Create a new problem in Freshservice. Use this tool to create a new problem in Freshservice when you need to log an issue or fault that may require investigation and resolution. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-problem'.
#

FreshserviceApi.CreateNewProduct

Create a new product in the Freshservice catalog. Use this tool to add a new product to the Freshservice Product Catalog. It is called when a new product entry is needed in the inventory or catalog database.

Parameters

ParameterTypeReq.Description
product_asset_type_idintegerRequiredIdentifier for the asset type of the product, expected as an integer.
product_namestringRequiredName of the Product to be added to the catalog.
depreciation_type_idintegerOptionalUnique identifier for the type of depreciation used for the product. This should be an integer value corresponding to the desired depreciation method.
depreciation_type_identifierstringOptionalUnique identifier for the depreciation type used for the product.
manufacturer_namestringOptionalThe name of the product's manufacturer. It accepts free text input.
procurement_modeintegerOptionalMode of procurement for the product. Use `1` for Buy, `2` for Lease, `3` for Both.
product_status_idintegerOptionalThe status of the product: `1` - In Production, `2` - In Pipeline, `3` - Retired.
product_unique_idintegerOptionalUnique identifier for the product in the catalog. It must be an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-product'.
#

FreshserviceApi.CreateNewRequester

Create a new requester in Freshservice. Use this tool to add a new requester to Freshservice whenever you need to register someone in the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-requester'.
#

FreshserviceApi.CreateNewVendor

Creates a new vendor in the Freshservice system. Use this tool to create a new vendor in Freshservice. Call this tool when you need to add a vendor to your vendor list, providing necessary details to complete the registration.

Parameters

ParameterTypeReq.Description
address_line_1stringOptionalThe first line of the vendor's address, such as street name and number.
address_line_2stringOptionalThe second line of the vendor's address, typically used for apartment or suite numbers.
countrystringOptionalThe country where the vendor is located. Provide the full name of the country.
location_zip_codestringOptionalZip Code of the vendor's location.
primary_contact_idintegerOptionalUnique ID of the primary contact for the vendor. This contact is a requester whose details (name, email, phone, mobile) are referenced from the requester database.
statestringOptionalThe state or province where the vendor is located. Use a string value to specify the state.
vendor_citystringOptionalThe city where the vendor is located.
vendor_descriptionstringOptionalDetailed description of the vendor, including any specific information or notes relevant to the vendor.
vendor_namestringOptionalThe name of the vendor to be created. It should be a string.
vendor_unique_idintegerOptionalUnique integer ID of the vendor to be created in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-vendor'.
#

FreshserviceApi.CreateOnboardingRequest

Create a new onboarding request in Freshservice. Use this tool to initiate a new employee onboarding process in Freshservice. It should be called when a new hire needs to be onboarded, capturing all necessary details and confirming the creation of the request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-onboarding-request'.
#

FreshserviceApi.CreateProblemTimeEntry

Create a new time entry for a problem in Freshservice. This tool creates a new time entry on a specified problem in Freshservice. It should be called when you need to log time spent on a problem within the service. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
problem_idintegerOptionalThe ID of the problem for which the time entry is to be created. Must be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-problem-time-entry'.
#

FreshserviceApi.CreateProjectTask

Create a new project task in Freshservice. Use this tool to create a new project task within Freshservice. It should be called when you need to add a task to an existing project. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
project_idintegerOptionalID of the project to which the task will be added. This must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-project-task'.
#

FreshserviceApi.CreatePurchaseOrder

Create a new Purchase Order in Freshservice. This tool is used to create a new Purchase Order in Freshservice. It should be called when a new order needs to be generated and recorded within the Freshservice system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-purchase-order-post'.
#

FreshserviceApi.CreateReleaseRequest

Initiate a new release request in Freshservice. This tool is used to create a new release request in Freshservice. It should be called when a user wants to start tracking or managing a release process within the Freshservice platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-release'.
#

FreshserviceApi.CreateReleaseTask

Create a new task on a Freshservice release. Use this tool to add a new task to a specific release in Freshservice, enabling detailed release management and tracking. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
release_idintegerOptionalID of the release to add a new task. It specifies the release context for task creation. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-release-task'.
#

FreshserviceApi.CreateSolutionArticle

Create a new solution article in Freshservice. Use this tool to add a new solution article to Freshservice. Call this tool when you need to document solutions or FAQs within the Freshservice platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-solution-article'.
#

FreshserviceApi.CreateSolutionCategory

Create a new solution category in Freshservice. This tool is used to create a new solution category in Freshservice. It should be called when you need to organize solutions by adding a new category in the Freshservice platform.

Parameters

ParameterTypeReq.Description
solution_category_namestringRequiredThe desired name for the new solution category to be created in Freshservice. It should be descriptive and unique.
is_default_categorybooleanOptionalSet to true if the category is a default one shipped with the product; such categories cannot have folders added or be renamed or deleted.
solution_category_descriptionstringOptionalProvide a description for the solution category.
solution_category_idintegerOptionalThe unique identifier for the solution category to be created in Freshservice.
solution_category_positionintegerOptionalThe position to display the solution category in Freshservice's category listing.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-solution-category'.
#

FreshserviceApi.CreateSolutionFolder

Create a new solution folder in Freshservice. Use this tool to create a new solution folder in Freshservice, helping organize solutions efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-solution-folder'.
#

FreshserviceApi.CreateTicketTask

Create a new task for a ticket in Freshservice. Use this tool to add a new task to an existing ticket in Freshservice. It should be called when a new task needs to be organized or managed within a specific ticket. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_id_for_task_creationintegerOptionalInteger ID of the ticket request for which a new task is to be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket-task'.
#

FreshserviceApi.CreateTicketTimeEntry

Create a new time entry on a Freshservice ticket. Use this tool to log a new time entry for a specific ticket in Freshservice. Useful for tracking time spent on ticket resolution or management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_idintegerOptionalThe ID of the ticket request for which the time entry will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket-time-entry'.
#

FreshserviceApi.DeactivateFreshserviceSurvey

Deactivate a CSAT survey in Freshservice using its ID. Use this tool to deactivate a Customer Satisfaction (CSAT) survey in Freshservice by providing the survey's ID. This is helpful when a survey is no longer needed or should not be sent to customers.

Parameters

ParameterTypeReq.Description
survey_idintegerRequiredThe integer ID of the CSAT survey to deactivate in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'deactivate-survey'.
#

FreshserviceApi.DeleteAgentAndTickets

Permanently delete an agent and their requested tickets. Use this tool to permanently delete an agent from the system along with any tickets they have requested.

Parameters

ParameterTypeReq.Description
agent_id_to_deleteintegerRequiredThe ID of the agent to permanently delete along with their tickets.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'forget-agent'.
#

FreshserviceApi.DeleteAgentGroup

Deletes an Agent Group in Freshservice by ID. Use this tool to delete an existing agent group in Freshservice by providing its ID. This is useful when you need to manage or reorganize agent groups by removing those that are no longer required.

Parameters

ParameterTypeReq.Description
agent_group_id_to_deleteintegerRequiredThe ID of the agent group you want to delete in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-agent-group'.
#

FreshserviceApi.DeleteAssetComponent

Delete a specific component from an asset in Freshservice. Use this tool to delete a specific component from an asset using Freshservice. It requires the asset's display ID and the component ID to successfully process the deletion request.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique identifier for the asset from which the component will be deleted. This must be an integer.
component_idintegerRequiredThe unique identifier of the component to be deleted.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-asset-component'.
#

FreshserviceApi.DeleteAssetType

Delete an existing asset type from Freshservice. This tool is used to delete an asset type in Freshservice. It should be called when an asset type is no longer needed and needs to be removed from the system.

Parameters

ParameterTypeReq.Description
asset_type_idintegerRequiredThe unique identifier for the asset type to be deleted. It should be an integer matching an existing asset type in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-asset-type'.
#

FreshserviceApi.DeleteCannedResponse

Delete a Canned Response from Freshservice. Use this tool to delete a specific Canned Response in Freshservice by providing its ID. Ideal for managing and cleaning up unused or outdated responses.

Parameters

ParameterTypeReq.Description
canned_response_idintegerRequiredThe unique ID of the canned response you want to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-canned-response'.
#

FreshserviceApi.DeleteCannedResponseFolder

Deletes a specified Canned Response Folder in Freshservice. This tool deletes a Canned Response Folder from Freshservice using the provided folder ID. Use it when you need to remove a specific folder.

Parameters

ParameterTypeReq.Description
canned_response_folder_idintegerRequiredThe unique ID of the Canned Response Folder to delete in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-caned-response-folder'.
#

FreshserviceApi.DeleteChangeNote

Delete a note from a Change request by ID in Freshservice. Use this tool to delete a specific note from a Change request in Freshservice by providing the change ID and note ID.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique identifier of the Change request from which the note is to be deleted.
note_idintegerRequiredThe unique identifier of the note to be deleted from the Change request in Freshservice. This is an integer value.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-change-note'.
#

FreshserviceApi.DeleteChangeRequest

Delete a change request by ID from Freshservice. Use this tool to delete a specific change request from Freshservice by providing the change ID. It confirms the deletion of the request.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique integer ID of the change request to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-change'.
#

FreshserviceApi.DeleteChangeRequestTask

Delete a task from a Freshservice change request. This tool deletes a specified task from a change request in Freshservice using the change and task IDs.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique integer ID of the change request from which the task will be deleted.
task_idintegerRequiredThe ID of the task to be deleted from the change request in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-change-task'.
#

FreshserviceApi.DeleteChangeTimeEntry

Deletes a specific time entry from a change request in Freshservice. Use this tool to delete a time entry associated with a specific change request in Freshservice. It requires the IDs of the change request and the time entry to process the deletion.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique identifier of the change request from which the time entry will be deleted. This is required to specify the change for the deletion process.
time_entry_idintegerRequiredThe unique identifier for the time entry to be deleted from a change request.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-change-time-entry'.
#

FreshserviceApi.DeleteDepartmentFreshservice

Delete a department or company in Freshservice by ID. Use this tool to delete a specific department or company (in MSP Mode) from Freshservice by providing the department ID. It should be called when needing to remove a department permanently.

Parameters

ParameterTypeReq.Description
department_id_to_deleteintegerRequiredSpecify the ID of the department or company to be deleted from Freshservice. This ID is required to identify which department to delete.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-department'.
#

FreshserviceApi.DeleteFreshserviceAnnouncement

Delete an announcement from Freshservice by ID. Use this tool to delete a specific announcement in Freshservice by providing the announcement ID. It confirms the successful deletion of the announcement.

Parameters

ParameterTypeReq.Description
announcement_id_to_deleteintegerRequiredID of the announcement to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-announcement'.
#

FreshserviceApi.DeleteFreshserviceProblem

Delete a problem by ID from Freshservice. Use this tool to delete a specific problem from Freshservice using its ID. This operation is useful when you need to remove a resolved or irrelevant problem from the system.

Parameters

ParameterTypeReq.Description
problem_id_to_deleteintegerRequiredEnter the ID of the problem you want to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-problem'.
#

FreshserviceApi.DeleteFreshserviceProblemNote

Delete a specific note from a problem in Freshservice. Use this tool to delete a specific note from a problem in Freshservice by providing the problem ID and note ID.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredThe unique ID of the note to be deleted from a problem in Freshservice.
problem_idintegerRequiredThe unique ID of the problem from which you want to delete a note. This ID is required to specify the target problem in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-problem-note'.
#

FreshserviceApi.DeleteFreshserviceProblemTimeEntry

Delete a specific time entry from a Freshservice problem. Use this tool to delete a specific time entry associated with a problem in Freshservice by providing the problem and time entry IDs.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredID of the problem from which the time entry will be deleted. This should be an integer value.
time_entry_idintegerRequiredThe numeric ID of the time entry to be deleted. This is required to identify which time entry to remove from the specified Freshservice problem.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-problem-time-entry'.
#

FreshserviceApi.DeleteFreshserviceProject

Delete an existing project in Freshservice. Use this tool to delete a specified project by its ID in the Freshservice platform. Ideal for managing and removing outdated or unnecessary projects.

Parameters

ParameterTypeReq.Description
project_idintegerRequiredThe unique identifier of the project to be deleted in Freshservice. This should be a numeric value.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-project'.
#

FreshserviceApi.DeleteFreshserviceRelease

Delete a release from Freshservice by its ID. Use this tool to delete a specific release in Freshservice when you have the release ID available. This is useful for managing and cleaning up outdated or erroneous releases in the system.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique integer ID of the release to delete in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-release'.
#

FreshserviceApi.DeleteLocation

Deletes an existing location by ID. Use this tool to delete a specified location by providing its ID in the Freshservice system.

Parameters

ParameterTypeReq.Description
location_idintegerRequiredThe unique ID of the location to be deleted in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-location'.
#

FreshserviceApi.DeleteProblemTask

Delete a specific task from a problem in Freshservice. Use this tool to delete a task associated with a specific problem in Freshservice by providing the problem and task IDs.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe unique identifier for the problem from which the task will be deleted.
task_idintegerRequiredThe unique integer ID of the task to be deleted from the specified problem.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-problem-task'.
#

FreshserviceApi.DeleteProductCatalogItem

Delete a product from the catalog. Use this tool to remove an existing product from the Freshservice Product Catalog. Useful for managing inventory or updating product listings by deleting outdated or irrelevant entries.

Parameters

ParameterTypeReq.Description
product_id_to_deleteintegerRequiredThe ID of the product to delete from the catalog. It should be an integer representing the unique identifier of the product.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-product'.
#

FreshserviceApi.DeleteProjectTask

Delete a project task in Freshservice. This tool deletes an existing project task in Freshservice. Use it when you need to remove a specific task from a project by providing the project and task identifiers.

Parameters

ParameterTypeReq.Description
project_identifierintegerRequiredThe unique identifier of the project from which the task should be deleted.
task_id_to_deleteintegerRequiredID of the task to be deleted in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-project-task'.
#

FreshserviceApi.DeletePurchaseOrder

Delete a purchase order in Freshservice by ID. Use this tool to delete a specific purchase order from Freshservice by providing its ID. This is useful when a purchase order needs to be permanently removed from the system.

Parameters

ParameterTypeReq.Description
purchase_order_idintegerRequiredThe unique integer ID of the purchase order to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-purchase-order'.
#

FreshserviceApi.DeleteReleaseNote

Deletes a specific release note in Freshservice. Use this tool to delete a note associated with a release in Freshservice by specifying the release and note IDs.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredThe unique identifier for the release note to be deleted in Freshservice.
release_idintegerRequiredThe unique integer ID of the release in Freshservice whose note is to be deleted.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-release-note'.
#

FreshserviceApi.DeleteReleaseTask

Delete a specific task from a release in Freshservice. Use this tool to delete a task from a specific release in Freshservice by providing the release ID and task ID.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique ID of the release from which the task should be deleted.
task_idintegerRequiredThe unique identifier for the task within a release to be deleted.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-release-task'.
#

FreshserviceApi.DeleteReleaseTimeEntry

Delete a specific time entry from a release in Freshservice. Use this tool to delete a specific time entry associated with a release in Freshservice by providing the release ID and time entry ID.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique identifier of the release from which the time entry will be deleted. This ID is required to specify the release in Freshservice.
time_entry_idintegerRequiredThe unique integer ID of the time entry to be deleted from a release in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-release-time-entry'.
#

FreshserviceApi.DeleteRequester

Delete a requester from Freshservice by ID. Use this tool to remove a requester from Freshservice using their unique ID. It should be called when a requester needs to be permanently deleted from the system.

Parameters

ParameterTypeReq.Description
requester_idintegerRequiredThe unique ID of the requester to be deleted from Freshservice. This ID should be an integer and is required to identify which requester needs to be removed.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-requester'.
#

FreshserviceApi.DeleteRequesterAndTickets

Permanently delete a requester and their tickets in Freshservice. This tool is used to permanently remove a requester and all of their associated tickets from Freshservice. It should be called when you need to completely erase a requester's data, including all their ticket history.

Parameters

ParameterTypeReq.Description
requester_id_to_deleteintegerRequiredThe ID of the requester to permanently delete along with their tickets.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'forget-requester'.
#

FreshserviceApi.DeleteSolutionArticle

Delete a specific solution article from Freshservice. Use this tool to delete a solution article in Freshservice by providing its ID. This can be useful for managing outdated or incorrect articles within the service.

Parameters

ParameterTypeReq.Description
solution_article_idintegerRequiredID of the solution article to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-solution-article'.
#

FreshserviceApi.DeleteSolutionCategory

Delete a solution category in Freshservice by ID. Use this tool to delete a specific solution category from Freshservice using the category ID. This is useful when you need to remove outdated or incorrect categories from your knowledge base.

Parameters

ParameterTypeReq.Description
solution_category_idintegerRequiredID of the solution category to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-solution-category'.
#

FreshserviceApi.DeleteSolutionFolder

Delete a solution folder from Freshservice. Use this tool to delete a solution folder by its ID in Freshservice when cleanup or reorganization is needed.

Parameters

ParameterTypeReq.Description
solution_folder_idintegerRequiredID of the solution folder to delete from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-solution-folder'.
#

FreshserviceApi.DeleteSurvey

Delete a survey and its responses from Freshservice. Use this tool to delete a specific survey from Freshservice by providing the survey ID. This action will remove the survey along with all its underlying responses.

Parameters

ParameterTypeReq.Description
survey_id_to_deleteintegerRequiredThe ID of the survey you wish to delete from Freshservice, including all underlying responses.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-survey'.
#

FreshserviceApi.DeleteTicketTask

Deletes a task from a Freshservice ticket. This tool deletes a specific task associated with a ticket in Freshservice, identified by the ticket and task ID. Use this to manage and update tasks on tickets efficiently.

Parameters

ParameterTypeReq.Description
task_idintegerRequiredThe unique ID of the task to delete from a Freshservice ticket.
ticket_identifierintegerRequiredThe unique integer ID of the ticket containing the task to be deleted.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-ticket-task'.
#

FreshserviceApi.DeleteTicketTimeEntry

Delete a time entry from a Freshservice ticket. Use this tool to delete a specific time entry from a ticket in Freshservice when it is no longer needed or was added incorrectly.

Parameters

ParameterTypeReq.Description
ticket_idintegerRequiredThe unique identifier of the ticket from which the time entry will be deleted. Provide a valid ticket ID.
time_entry_idintegerRequiredThe ID of the time entry to be deleted from the ticket.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-ticket-time-entry'.
#

FreshserviceApi.DeleteVendor

Delete an existing vendor in Freshservice. This tool deletes a specified vendor in Freshservice. It should be called when a user needs to remove a vendor from the system using the vendor's unique ID.

Parameters

ParameterTypeReq.Description
vendor_idintegerRequiredThe unique integer ID of the vendor to be deleted in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-vendor'.
#

FreshserviceApi.EditFreshserviceTicket

Edit a Freshservice ticket efficiently. This tool is used to update the details of an existing ticket in Freshservice. It should be called when modifications or updates to a ticket's information are needed, such as changing the status, priority, or other relevant ticket details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_idintegerOptionalThe ID of the Freshservice ticket to update. Must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-ticket'.
#

FreshserviceApi.EditTicketConversation

Edit a conversation in a Freshservice ticket. Use this tool to edit the conversation on an existing Freshservice ticket. It is useful for updating information, correcting errors, or adding new details to a specific conversation within a ticket. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_identifierintegerOptionalInteger representing the ID of the ticket whose conversation needs editing. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
conversation_idintegerOptionalID of the reply or note that needs to be updated in the Freshservice ticket. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-ticket-conversation'.
#

FreshserviceApi.FetchAgentFields

Retrieve all agent fields in Freshservice. Use this tool to get a complete list of agent fields from Freshservice. This could be useful for understanding the available fields when managing agents.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecify the number of entries to retrieve per page in the paginated list.
page_number_to_retrieveintegerOptionalThe page number to retrieve in the list of agent fields.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-agent-fields'.
#

FreshserviceApi.FetchOnboardingRequest

Retrieve a specific onboarding request by ID. Use this tool to get details about a specific onboarding request from Freshservice by providing the request ID.

Parameters

ParameterTypeReq.Description
onboarding_request_idintegerRequiredThe ID number representing the specific onboarding request to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-onboarding-request'.
#

FreshserviceApi.FetchOnboardingTickets

Retrieve tickets for specific onboarding requests. This tool fetches details of FreshService Tickets linked to a particular Onboarding Request. Use it to access related ticket information based on the onboarding request ID.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-onboarding-request-tickets'.
#

FreshserviceApi.FetchRequesterInfo

Retrieve requester details using their ID from Freshservice. Use this tool to get detailed information about a requester by providing their ID through Freshservice's API.

Parameters

ParameterTypeReq.Description
requester_idintegerRequiredInteger representing the ID of the requester to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-requester'.
#

FreshserviceApi.FetchTicketLocation

Retrieve details of a specific location by ID. This tool retrieves detailed information about a specific location using its ID. It should be used when needing to fetch data related to a particular location in Freshservice.

Parameters

ParameterTypeReq.Description
location_idintegerRequiredThe ID of the location to retrieve. This should be an integer representing the specific location's unique identifier in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-location'.
#

FreshserviceApi.FetchTicketTimeEntry

Retrieve a specific time entry for a ticket in Freshservice. This tool is used to fetch details of a specific time entry associated with a ticket in Freshservice by providing the ticket and time entry IDs.

Parameters

ParameterTypeReq.Description
ticket_request_idintegerRequiredThe unique integer ID of the ticket request for which the time entry details are needed.
time_entry_idintegerRequiredThe unique identifier for the time entry you want to retrieve details for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-ticket-time-entry'.
#

FreshserviceApi.GetAgentGroups

Retrieve a list of all agent groups from Freshservice. Use this tool to obtain a list of all the agent groups configured in your Freshservice account. It is useful for managing groups and understanding team structures within the system.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of entries to retrieve per page for pagination.
page_numberintegerOptionalThe page number to retrieve for pagination in the list of agent groups.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-agent-groups'.
#

FreshserviceApi.GetAllRequesters

Retrieve a list of all requesters in Freshservice. Call this tool to get a comprehensive list of all requesters from the Freshservice platform.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of requesters to retrieve per page in the list.
filter_by_mobile_phone_numberstringOptionalThe mobile phone number to filter and list corresponding requesters.
filter_by_work_phone_numberstringOptionalThe work phone number to filter requesters by. Returns requesters matching the specified work phone number.
list_active_user_accountsbooleanOptionalSet to true to list only active user accounts. If false or not set, both active and deactivated accounts are returned.
requester_emailstringOptionalThe email address to list the corresponding requester. Use this to filter results to a specific requester by email.
requester_filter_querystringOptionalA URL-encoded string to filter the list of requesters. Use parameters like first_name, job_title, etc. Example: "job_title:'HR Manager' AND created_at:>'2018-08-10'".
retrieve_page_numberintegerOptionalSpecify the page number to retrieve in the list of requesters.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-requesters'.
#

FreshserviceApi.GetApplicationLicenses

Retrieve licenses for a specified software application. Use this tool to get a list of all licenses linked to a particular software application within Freshservice.

Parameters

ParameterTypeReq.Description
application_idintegerRequiredThe unique identifier for the software application to retrieve associated licenses.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-application-licenses'.
#

FreshserviceApi.GetAssetContracts

Retrieve contracts linked to a specific asset. Use this tool to obtain all contracts associated with a particular asset identified by its display ID. Ideal for managing asset-related agreements and tracking contract details.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique integer ID of the asset to retrieve associated contracts for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-contracts'.
#

FreshserviceApi.GetAssetRequests

Retrieve requests linked to a specific asset. Use this tool to get a list of all requests associated with a specific asset by its display ID.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique display ID of the asset for which to retrieve requests. This should be an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-requests'.
#

FreshserviceApi.GetAssetTypeFields

Retrieve asset fields from Freshservice. Fetches asset fields for a specific asset type from Freshservice, including default and specific fields, in their UI display order.

Parameters

ParameterTypeReq.Description
asset_type_identifierintegerRequiredThe unique integer ID representing the specific asset type whose fields need to be retrieved.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-type-fields'.
#

FreshserviceApi.GetBusinessHoursConfig

Retrieve the Business Hours configuration from Freshservice. This tool retrieves the Business Hours configuration using the provided ID from Freshservice. It should be called when detailed information about specific business hours settings is required.

Parameters

ParameterTypeReq.Description
business_hours_configuration_idintegerRequiredThe unique ID of the Business Hours configuration to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-business-hours-config'.
#

FreshserviceApi.GetBusinessHoursConfigs

Retrieve all business hours configurations from Freshservice. This tool retrieves the entire list of business hours configurations from Freshservice. It should be called when you need to understand or display the business hours settings configured in the Freshservice system.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of business hours configurations to retrieve per page in the paginated result.
page_numberintegerOptionalThe specific page number of business hours configurations to retrieve.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-business-hours-configs'.
#

FreshserviceApi.GetCannedResponse

Retrieve details of a Freshservice canned response by ID. Use this tool to obtain the details of a specific canned response from Freshservice, given its unique ID.

Parameters

ParameterTypeReq.Description
canned_response_idintegerRequiredThe unique ID of the canned response to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-canned-response'.
#

FreshserviceApi.GetCannedResponseFolder

Retrieve a specific canned response folder from Freshservice. Use this tool to fetch the details of a specific canned response folder by its ID from Freshservice. It is helpful for accessing pre-defined response templates for customer support or information retrieval.

Parameters

ParameterTypeReq.Description
canned_response_folder_idintegerRequiredID of the canned response folder to be retrieved from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-canned-response-folder'.
#

FreshserviceApi.GetCannedResponseFolders

Retrieve all canned response folders from Freshservice. This tool retrieves a list of all canned response folders available in Freshservice. It should be called when you need to access or manage pre-written responses for different scenarios or queries in Freshservice.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-canned-response-folders'.
#

FreshserviceApi.GetChangeFormFields

Retrieve fields for the Change Object in Freshservice. Use this tool to obtain a list of all fields that make up the Change Object in Freshservice. Ideal for understanding the structure or schema of change forms.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-change-form-fields'.
#

FreshserviceApi.GetChangeRequest

Retrieve a specific change request by ID from Freshservice. Use this tool to access information about a specific change request in Freshservice by providing its unique ID.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredID of the change request to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-change'.
#

FreshserviceApi.GetChangeRequestNotes

Retrieve notes from a Freshservice change request. Use this tool to get all notes associated with a specific change request ID in Freshservice.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique ID of the change request to retrieve notes for, required to access specific change request data.
notes_per_pageintegerOptionalSpecify the number of notes to retrieve per page for pagination.
page_numberintegerOptionalThe page number to retrieve for paginated notes.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-change-notes'.
#

FreshserviceApi.GetChangeRequestTasks

Retrieve tasks for a specific Change request from Freshservice. Use this tool to get all tasks associated with a specific Change request using its ID in Freshservice. Ideal for managing or reviewing change tasks.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredID of the Change request to retrieve tasks for in Freshservice.
page_number_to_retrieveintegerOptionalThe specific page number of tasks to be retrieved for a Change request.
tasks_per_pageintegerOptionalSpecify the number of tasks to retrieve per page in a paginated response.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-change-tasks'.
#

FreshserviceApi.GetChangeRequestTimeEntries

Retrieve time entries for a specific Change request. Use this tool to get all time entries associated with a specific Change request in Freshservice by providing the Change ID.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe ID of the Change request to retrieve time entries for in Freshservice.
entries_per_pageintegerOptionalNumber of time entries to retrieve per page in the paginated list.
page_number_to_retrieveintegerOptionalSpecify the page number of the time entries to retrieve for paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-change-time-entries'.
#

FreshserviceApi.GetCsatSurveys

Retrieve a list of all CSAT Surveys in Freshservice.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of survey entries to retrieve per page in a paginated response.
filter_active_surveysintegerOptionalSet to 1 to list active surveys or 0 for inactive surveys.
page_number_to_retrieveintegerOptionalSpecify the page number of the CSAT surveys to retrieve.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-surveys'.
#

FreshserviceApi.GetDepartmentFields

Retrieve department fields from Freshservice. Use this tool to get the Department Fields or Company Fields (in MSP Mode) from Freshservice, displayed in the order found on the UI.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-department-fields'.
#

FreshserviceApi.GetDepartmentInfo

Retrieve department details from Freshservice using an ID. Use this tool to obtain detailed information about a department or company (in MSP Mode) from Freshservice by providing the specific department ID.

Parameters

ParameterTypeReq.Description
department_idintegerRequiredThe ID of the department to retrieve details for from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-department'.
#

FreshserviceApi.GetDeviceComponents

Retrieve all components of a specific device. This tool retrieves a list of all components associated with a specified device by its display ID. Use this to gain detailed insights into the individual parts of a device.

Parameters

ParameterTypeReq.Description
device_display_idintegerRequiredThe unique display ID of the device whose components are to be listed. It must be an integer value.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-components'.
#

FreshserviceApi.GetFreshserviceAgentInfo

Retrieve details of a Freshservice agent by ID. Use this tool to obtain information about a specific agent in Freshservice by providing the agent's ID. It can be called when detailed agent information is needed for administration or support purposes.

Parameters

ParameterTypeReq.Description
agent_identifierintegerRequiredThe unique ID of the agent to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-agent'.
#

FreshserviceApi.GetFreshserviceAnnouncement

Retrieve a specific announcement from Freshservice. Call this tool to get details of an announcement using its ID from Freshservice.

Parameters

ParameterTypeReq.Description
announcement_idintegerRequiredThe unique integer ID of the announcement to be retrieved from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-announcement'.
#

FreshserviceApi.GetFreshserviceAnnouncements

Retrieve a list of all announcements from Freshservice. Use this tool to get all current announcements in Freshservice. Call this when you need to display or access information about company or service announcements.

Parameters

ParameterTypeReq.Description
announcement_statestringOptionalFilter announcements by their state: archived, active, scheduled, or unread.
announcements_per_pageintegerOptionalSpecify the number of announcements to retrieve per page for pagination.
page_numberintegerOptionalThe page number to retrieve for paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-announcement'.
#

FreshserviceApi.GetFreshserviceChangeList

Retrieve a list of all changes in Freshservice. Use this tool to get a comprehensive list of changes in Freshservice. It can be called when you need to access or review all changes recorded in the Freshservice system.

Parameters

ParameterTypeReq.Description
changes_per_pageintegerOptionalSpecify the number of changes to retrieve per page in a paginated list.
filter_by_updated_sincestringOptionalRetrieve changes updated since a specific date (in ISO 8601 format).
filter_name_for_change_retrievalstringOptionalSpecify the filter to retrieve changes, such as 'my_open', 'unassigned', or 'closed'.
page_numberintegerOptionalThe page number of the change list to retrieve from Freshservice.
requester_emailstringOptionalThe email address of the requester to filter changes by their email.
requester_idstringOptionalSpecify the requester ID to filter changes associated with this ID.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-changes'.
#

FreshserviceApi.GetFreshserviceDepartments

Retrieve a list of departments from Freshservice. Use this tool to get a list of all departments or companies (in MSP Mode) available in Freshservice.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of departments to retrieve in each page of a paginated list. Must be an integer.
page_number_to_retrieveintegerOptionalThe page number of results to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-departments'.
#

FreshserviceApi.GetFreshserviceProblems

Retrieve all problems from Freshservice. This tool fetches a list of all problems recorded in Freshservice. It should be called when there is a need to access or review issues tracked in the system.

Parameters

ParameterTypeReq.Description
page_number_to_retrieveintegerOptionalSpecify the page number to retrieve from the paginated list of problems.
problems_per_pageintegerOptionalSpecify the number of problems to retrieve per page in a paginated list.
retrieve_problems_updated_sincestringOptionalRetrieve problems updated since the specified date (in ISO 8601 format).

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-problems'.
#

FreshserviceApi.GetFreshserviceRelease

Retrieve release details from Freshservice by ID. Call this tool to obtain specific release details from Freshservice using a provided release ID.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredID of the release to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-release'.
#

FreshserviceApi.GetFreshserviceReleases

Retrieve a list of all Releases in Freshservice. Use this tool to obtain a complete list of all Releases within the Freshservice platform. Useful for tracking, managing, and reviewing release information.

Parameters

ParameterTypeReq.Description
page_numberintegerOptionalIndicates which page of the release list to retrieve in a paginated response.
release_updated_sincestringOptionalRetrieve releases updated after the specified date (in YYYY-MM-DD format).
releases_per_pageintegerOptionalThe number of releases to retrieve per page in the paginated list.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-releases'.
#

FreshserviceApi.GetFreshserviceReleaseTask

Retrieve a specific task for a release in Freshservice. Call this tool to get information about a specific task within a release in Freshservice using the release and task IDs.

Parameters

ParameterTypeReq.Description
release_identifierintegerRequiredThe numeric ID of the release to retrieve the task from.
task_idintegerRequiredThe unique integer ID of the task to retrieve within a release in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-release-task'.
#

FreshserviceApi.GetFreshserviceTicketDetails

Retrieve details of a FreshService ticket by ID. Use this tool to obtain detailed information about a specific ticket in Freshservice when given a ticket ID.

Parameters

ParameterTypeReq.Description
ticket_idintegerRequiredThe unique ID of the FreshService ticket to fetch details for.
include_additional_ticket_fieldsstringOptionalSpecify fields to include in the ticket response, like 'stats' or 'requester'. Supported options are conversations, requester, problem, stats, assets, change, related_tickets.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-ticket'.
#

FreshserviceApi.GetInstalledSoftwareList

Retrieve all software installed on a specific device. Use this tool to obtain a comprehensive list of software applications installed on a particular device by its display ID.

Parameters

ParameterTypeReq.Description
device_display_idintegerRequiredThe unique integer identifier for the device to fetch the software list.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-applications'.
#

FreshserviceApi.GetLocations

Retrieve a list of all locations in Freshservice. Call this tool to obtain a comprehensive list of all locations configured in the Freshservice system. Useful for management and administrative tasks requiring location data.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of location entries to retrieve per page in the paginated list.
page_number_to_retrieveintegerOptionalThe page number of the locations list you want to retrieve. Useful for navigating through paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-locations'.
#

FreshserviceApi.GetOnboardingRequestForm

Retrieve all fields in the onboarding request form. This tool retrieves a list of all fields in the initiator onboarding request form from Freshservice, which can be used to understand the data structure required for the onboarding process. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-onboarding-request-form'.
#

FreshserviceApi.GetProblemTasks

Retrieve tasks associated with a specific problem ID. Use this tool to get the list of tasks related to a particular problem in Freshservice by providing the problem ID.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe ID of the problem for which tasks need to be retrieved. This identifies the specific problem in Freshservice.
page_numberintegerOptionalThe page number of the task list to retrieve.
tasks_per_pageintegerOptionalThe number of tasks to retrieve per page in the paginated list.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-problem-tasks'.
#

FreshserviceApi.GetProblemTimeEntries

Retrieve time entries for a specific Freshservice problem. Use this tool to get all time entries associated with a particular problem in Freshservice by providing the problem ID.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe unique ID of the Freshservice problem to retrieve time entries for.
entries_per_pageintegerOptionalThe number of time entries to retrieve in each page of a paginated list.
page_number_to_retrieveintegerOptionalThe page number to retrieve from the paginated list of time entries for the specified problem.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-problem-time-entries'.
#

FreshserviceApi.GetProductInfo

Retrieve a specific Product from the Product Catalog. Use this tool to get detailed information about a specific product using its ID from the Freshservice Product Catalog.

Parameters

ParameterTypeReq.Description
product_idintegerRequiredThe unique identifier of the product to retrieve from the catalog.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-product'.
#

FreshserviceApi.GetProjectDetails

Retrieve detailed information about a specific project. Use this tool to obtain comprehensive data for a project by specifying the project ID. It accesses the Freshservice API to fetch and return details, helping in managing and understanding ongoing projects.

Parameters

ParameterTypeReq.Description
project_idintegerRequiredThe integer ID of the project to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-project'.
#

FreshserviceApi.GetProjectTasks

Retrieve a list of project tasks from Freshservice. Use this tool to get a list of all tasks within a specific project in Freshservice. It should be called when you need detailed task information for project management or tracking purposes.

Parameters

ParameterTypeReq.Description
project_idintegerRequiredThe ID of the project whose tasks are to be retrieved.
entries_per_pageintegerOptionalSpecify the number of entries to retrieve per page in a paginated task list.
page_number_to_retrieveintegerOptionalThe page number of the project tasks list to retrieve.
task_filterstringOptionalFilter tasks by status: all, open, in_progress, completed, overdue, unassigned.
task_parent_idintegerOptionalFilter tasks by their parent task ID. Useful for narrowing down tasks under specific parent tasks.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-project-tasks'.
#

FreshserviceApi.GetPurchaseOrders

Retrieve all purchase orders from Freshservice. Use this tool to get a comprehensive list of all purchase orders recorded in the Freshservice system. It's useful for tasks that require an overview of procurement activities.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecify the number of entries to retrieve per page in a paginated list. This helps manage and control the pagination results.
page_numberintegerOptionalThe specific page number to retrieve from the paginated list of purchase orders.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-purchase-orders'.
#

FreshserviceApi.GetReleaseFormFields

Retrieve fields of the Release Object in Freshservice. Use this tool to obtain all fields that make up the Release Object in Freshservice. This is useful when needing to understand or display the structure of a release form.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-release-form-fields'.
#

FreshserviceApi.GetReleaseNote

Retrieve a note from a specific release in Freshservice. This tool retrieves a specific note associated with a given release ID from Freshservice. It is useful for accessing detailed notes or updates related to particular releases.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredThe unique integer ID of the note to be retrieved from the release.
release_idintegerRequiredThe unique identifier for a specific release to retrieve the note from.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-release-note'.
#

FreshserviceApi.GetReleaseNotes

Retrieve notes for a specified release in Freshservice. Use this tool to get detailed notes on a release by providing the release ID. It is useful for obtaining updates and information documented in a particular release within Freshservice.

Parameters

ParameterTypeReq.Description
release_identifierintegerRequiredThe ID representing the release for which notes are to be retrieved.
notes_per_pageintegerOptionalThe number of notes to retrieve per page in the paginated result.
page_number_to_retrieveintegerOptionalIndicates which page of notes to retrieve for the specified release.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-release-note'.
#

FreshserviceApi.GetReleaseTasks

Retrieve all tasks for a specified release in Freshservice. This tool is used to obtain a list of tasks associated with a specific release ID from Freshservice. It is useful when you need detailed information about tasks related to a release.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique ID of the release for which tasks are to be retrieved from Freshservice.
page_number_to_retrieveintegerOptionalSpecify the page number of tasks to retrieve for pagination.
tasks_per_pageintegerOptionalThe number of tasks to retrieve per page in a paginated list.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-release-tasks'.
#

FreshserviceApi.GetReleaseTimeEntries

Retrieve time entries for a specified release. This tool retrieves the time entries associated with a given Release ID from Freshservice. It should be called when there's a need to review or analyze time tracking data for a specific release in Freshservice.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe ID of the release for which time entries are to be retrieved from Freshservice.
entries_per_pageintegerOptionalThe number of time entries to retrieve per page in a paginated list.
page_number_to_retrieveintegerOptionalSpecify the page number of the time entries to retrieve for the given release.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-release-time-entries'.
#

FreshserviceApi.GetServiceItemFields

Retrieve all fields of a specified service item in Freshservice. This tool retrieves detailed information about all the fields of a specified service item from Freshservice, using the service item's ID.

Parameters

ParameterTypeReq.Description
service_item_idintegerRequiredThe integer ID of the service item to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-catalog-item-fields'.
#

FreshserviceApi.GetServiceItems

Retrieve a list of all service items in Freshservice. Use this tool to get a complete list of service items available in your Freshservice account. It should be called when you need detailed information about the service items.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecifies the number of entries to retrieve in each page of the service items list.
page_numberintegerOptionalThe page number to retrieve from the list of service items.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-service-items'.
#

FreshserviceApi.GetSolutionArticles

Retrieve all Solution articles from Freshservice. This tool is used to gather a complete list of Solution articles available in Freshservice. It should be called when you need to access or display the entire collection of articles.

Parameters

ParameterTypeReq.Description
category_identifierintegerOptionalThe unique identifier for the category whose solution articles need to be retrieved.
entries_per_pageintegerOptionalThe number of solution articles to retrieve per page for pagination.
folder_idintegerOptionalThe ID of the folder whose solution articles need to be retrieved.
page_numberintegerOptionalThe specific page number of the solution articles to retrieve.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-solution-article'.
#

FreshserviceApi.GetSolutionCategories

Retrieve a list of all solution categories in Freshservice.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecify the number of entries to retrieve per page in a paginated list.
page_number_to_retrieveintegerOptionalThe page number of solution categories to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-solution-category'.
#

FreshserviceApi.GetTicketConversations

Fetches all conversations from a specified Freshservice ticket. Use this tool to retrieve a list of all conversations associated with a specific ticket in Freshservice. This can be helpful for reviewing past interactions and understanding communication history related to the ticket.

Parameters

ParameterTypeReq.Description
ticket_idintegerRequiredID of the ticket from Freshservice for fetching conversations.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-ticket-conversations'.
#

FreshserviceApi.GetTicketTimeEntries

Retrieve time entries for a specific ticket in Freshservice. Use this tool to get all time entries associated with a specific ticket ID from Freshservice. Ideal for tracking time spent and managing ticket details.

Parameters

ParameterTypeReq.Description
ticket_request_idintegerRequiredThe ID of the ticket request for which the time entries need to be retrieved. This should be an integer value identifying a specific ticket in Freshservice.
entries_per_pageintegerOptionalNumber of time entries to retrieve per page in a paginated list.
page_numberintegerOptionalThe page number of time entries to retrieve for the given ticket ID.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-ticket-time-entries'.
#

FreshserviceApi.GetUserOnboardingRequests

Retrieve all onboarding requests for a specific user. Use this tool to obtain all onboarding requests associated with a particular user, aiding in user management and tracking.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-onboarding-requests'.
#

FreshserviceApi.GetVendorList

Retrieve a list of all vendors from Freshservice. Use this tool to get a complete list of vendors stored in the Freshservice system. It's useful for acquiring vendor information when managing resources or contracts.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecify the number of vendor entries to retrieve in each page of a paginated list.
page_numberintegerOptionalSpecifies which page number of vendor entries to retrieve. Useful for navigating paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-vendors'.
#

FreshserviceApi.ListAllProducts

Retrieve all products from Freshservice. Use this tool to get a comprehensive list of all the products available in the Freshservice system. This helps in managing and reviewing product inventories effectively.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of entries to retrieve in each page of a paginated list. This controls the page size.
page_number_to_fetchintegerOptionalThe specific page number to retrieve from the list of products.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-products'.
#

FreshserviceApi.ListApplicationInstallations

Retrieve all devices with a specific software installed. This tool fetches a list of devices where a specified software application is installed. It should be called when you need to determine which devices have a certain software application installed by providing the application ID.

Parameters

ParameterTypeReq.Description
software_application_idintegerRequiredThe unique identifier for the software application to get installation details.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-application-installations'.
#

FreshserviceApi.ListAssets

Retrieve a list of all assets in Freshservice. This tool is used to get a complete list of all assets available in the Freshservice platform. It can be called to fetch detailed inventory information, aiding in asset management tasks.

Parameters

ParameterTypeReq.Description
asset_filter_querystringOptionalA URL-encoded query string to filter the asset list. Supports parameters like asset_type_id, department_id, location_id, and more.
entries_per_pageintegerOptionalSpecify the number of asset entries to retrieve per page in a paginated list. Not applicable when a search or filter is used.
include_asset_type_fieldsstringOptionalSpecify asset type fields to include in the response.
list_trashed_assets_onlybooleanOptionalSet to true to list only assets in the trash.
page_numberintegerOptionalThe page number to retrieve from the list of assets.
search_querystringOptionalA simple query to search for an asset. Supports 'name', 'asset_tag', and 'serial_number'. Example: "name:'dell monitor'".

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-assets'.
#

FreshserviceApi.ListAssetTypes

Fetch a list of all asset types from Freshservice. Use this to get an overview of all asset types defined within Freshservice. Useful for managing assets or integrating asset data with other systems.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of asset types to retrieve per page in the list.
page_numberintegerOptionalThe page number to retrieve for paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-asset-types'.
#

FreshserviceApi.ListCannedResponses

Retrieve canned responses from a specified folder in Freshservice. Call this tool to obtain a list of all canned responses within a specified canned response folder in Freshservice. It's useful for accessing predefined replies saved in a particular folder.

Parameters

ParameterTypeReq.Description
canned_response_folder_idintegerRequiredThe ID of the canned response folder to retrieve responses from.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-canned-response-folders-canned-responses'.
#

FreshserviceApi.ListComponentTypes

Retrieve all Freshservice component types and their fields. Use this tool to obtain a list of all component types available in Freshservice. It provides details about each component type and their specific fields, which can be useful for understanding how components are organized.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecifies the number of component type entries to retrieve in each page.
page_numberintegerOptionalThe page number to retrieve in a paginated list of component types.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-component-types'.
#

FreshserviceApi.ListFreshserviceAgents

Retrieve a list of all agents from Freshservice. Call this tool to get a comprehensive list of all agents present in your Freshservice account. It will return the agent details necessary for managing or reviewing team configurations.

Parameters

ParameterTypeReq.Description
agent_employment_statusstringOptionalSpecifies if the list should include full-time or occasional agents. Use 'fulltime' or 'occasional'.
entries_per_pageintegerOptionalSpecify the number of entries to retrieve per page in the result set.
filter_by_mobile_phone_numberstringOptionalFilter agents by the given mobile phone number.
filter_by_work_phone_numberstringOptionalFilter agents by their work phone number to retrieve corresponding requesters.
list_active_accountsbooleanOptionalList only active user accounts. Use true for active accounts, false for deactivated ones.
page_number_to_retrieveintegerOptionalThe specific page number to retrieve in the list of Freshservice agents.
query_filterstringOptionalA URL-encoded query string to filter agents based on parameters like first_name, job_title, etc. Example: "job_title:'HR Manager' AND created_at:>'2018-08-10'".
requester_emailstringOptionalThe email address to find the corresponding requester agent in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-agents'.
#

FreshserviceApi.ListFreshserviceProjects

Retrieve all projects from Freshservice. Use this tool to obtain a comprehensive list of projects stored in the Freshservice platform. Ideal for users needing to access or review project details managed within Freshservice.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of projects to retrieve per page in a paginated result set from Freshservice.
filter_archived_projectsbooleanOptionalSet to true to retrieve archived projects, false for active projects.
filter_project_statusstringOptionalFilter projects based on their status: all, open, in_progress, or completed.
page_numberintegerOptionalThe specific page number of projects to retrieve for paginated results.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-projects'.
#

FreshserviceApi.ListFreshserviceTickets

Fetch a list of tickets from Freshservice. Use this tool to retrieve all tickets currently in Freshservice. Ideal for viewing open or closed tickets and managing support inquiries.

Parameters

ParameterTypeReq.Description
filter_by_requester_emailstringOptionalFilter tickets by the requester's email address.
include_fields_in_responsestringOptionalSpecify certain fields to include in the response. Examples: 'stats' for ticket's closed and resolved times, 'requester' for requester's details.
requester_id_filterintegerOptionalFilter tickets by the ID of the requester to view those created by a specific user.
ticket_filterstringOptionalApply a pre-defined filter to fetch specific types of tickets. Options are: new_and_my_open, watching, spam, deleted.
ticket_sort_orderstringOptionalSort the list of tickets in ascending ('asc') or descending ('desc') order. Default is 'desc'.
updated_sincestringOptionalFilter tickets based on their update timestamp. Use ISO 8601 format, e.g., '2015-01-19T02:00:00Z'.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-tickets'.
#

FreshserviceApi.ListRequesterFields

Retrieve a list of all requester fields in Freshservice. Use this tool to obtain a complete list of requester fields in your Freshservice instance.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalNumber of requester fields to retrieve per page in the paginated list.
page_numberintegerOptionalThe page number to retrieve in a paginated list of requester fields.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-requester-fields'.
#

FreshserviceApi.ListSoftwareApplications

Retrieve a list of software applications from Freshservice. Use this tool to get a comprehensive list of all software applications available in Freshservice. This can be helpful for inventory management or IT support inquiries.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalSpecify the number of software application entries to retrieve per page.
page_number_to_retrieveintegerOptionalThe specific page number of the software list to retrieve from Freshservice. Useful for navigating large lists.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-applications'.
#

FreshserviceApi.MergeSecondaryRequesters

Merge secondary requesters into a primary requester. Use this tool to combine one or more secondary requester profiles into a primary requester profile, consolidating their information into a single account.

Parameters

ParameterTypeReq.Description
primary_requester_idintegerRequiredThe ID of the primary requester to merge other requesters into.
secondary_requester_idsarray<integer>RequiredList of IDs of secondary requesters to be merged into the primary requester.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'merge-requester'.
#

FreshserviceApi.PostTicketReply

Add a reply to a Freshservice ticket. This tool allows you to post a new reply to a specified ticket in Freshservice. Use it when you need to update a ticket with additional information or respond to queries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_idintegerOptionalID of the ticket to which the reply will be added. This must be an integer representing the unique identifier of the ticket. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'create-ticket-reply'.
#

FreshserviceApi.RemoveAssetType

Delete an existing asset type in Freshservice. Use this tool to delete an asset type by providing its display ID. Call this tool when you need to remove an asset from the Freshservice system.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique integer identifier of the asset type to be deleted in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-asset'.
#

FreshserviceApi.RemoveFreshserviceTicket

Remove a ticket from Freshservice. Use this tool to delete a ticket in Freshservice by providing the ticket ID. It should be called when a ticket needs to be removed from the system.

Parameters

ParameterTypeReq.Description
ticket_idintegerRequiredThe unique ID of the Freshservice ticket to delete.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-ticket'.
#

FreshserviceApi.RemoveTicketConversation

Remove a conversation from a Freshservice ticket. Use this tool to delete a specific conversation from a Freshservice ticket. Ideal for managing ticket discussions by removing unnecessary or old conversations.

Parameters

ParameterTypeReq.Description
conversation_idintegerRequiredID of the reply or note that needs to be deleted from a Freshservice ticket.
ticket_id_for_removalintegerRequiredThe ID of the Freshservice ticket from which the conversation should be removed.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'delete-ticket-conversation'.
#

FreshserviceApi.RestoreArchivedProject

Restore an archived project in Freshservice. Use this tool to restore a previously archived project within the Freshservice platform. It is useful when you need to reactivate a project for continued work or review.

Parameters

ParameterTypeReq.Description
project_idintegerRequiredThe unique integer ID of the archived project to restore in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'restore-project'.
#

FreshserviceApi.RestoreDeletedTicket

Restore a deleted ticket in Freshservice. Use this tool to restore a deleted ticket in Freshservice by specifying the ticket ID. Call this when you need to recover a ticket that was previously deleted.

Parameters

ParameterTypeReq.Description
ticket_idintegerRequiredProvide the integer ID of the ticket you want to restore in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'restore-ticket'.
#

FreshserviceApi.RetrieveAgentGroupById

Retrieve details of a specific agent group by ID. Use this tool to get information about an agent group from Freshservice using its unique ID.

Parameters

ParameterTypeReq.Description
agent_group_idintegerRequiredThe unique ID of the agent group to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-agent-group'.
#

FreshserviceApi.RetrieveAssetInformation

Retrieve detailed information about a specific asset. Use this tool to get detailed information about a specific asset in the Freshservice system using its display ID.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique display ID of the asset you want to retrieve information for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-asset'.
#

FreshserviceApi.RetrieveAssetType

Retrieve details of a specific asset type from Freshservice. Use this tool to obtain information about a specific asset type identified by its asset type ID within the Freshservice system.

Parameters

ParameterTypeReq.Description
asset_type_idintegerRequiredThe unique ID of the asset type to retrieve. Must be an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-asset-type'.
#

FreshserviceApi.RetrieveCannedResponses

Retrieve a list of all Canned Responses in Freshservice.

Parameters

No parameters required.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-canned-responses'.
#

FreshserviceApi.RetrieveChangeNote

Retrieve a note on a Change request from Freshservice. Use this tool to get details of a specific note associated with a Change request by providing the change and note IDs.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique identifier for the change request. Provide this to retrieve the specific note associated with it.
note_idintegerRequiredThe unique identifier for the note you want to retrieve from a Change request.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-change-note'.
#

FreshserviceApi.RetrieveChangeTimeEntry

Retrieve a time entry on a Change request by ID. Use this tool to obtain details about a specific time entry associated with a Change request in Freshservice, identified by its Change ID.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredID of the change request to retrieve the specific time entry.
time_entry_idintegerRequiredThe unique ID of the specific time entry to be retrieved.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-change-time-entry'.
#

FreshserviceApi.RetrieveCsatSurvey

Retrieve a CSAT survey by ID from Freshservice. Use this tool to fetch detailed information about a Customer Satisfaction (CSAT) survey from Freshservice by providing the survey ID. Ideal for accessing survey feedback and metrics.

Parameters

ParameterTypeReq.Description
csat_survey_idintegerRequiredID of the CSAT survey to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-survey'.
#

FreshserviceApi.RetrieveFreshserviceChangeTask

Retrieve a task from a Freshservice Change request by ID. Use this tool to fetch details of a specific task associated with a Change request in Freshservice, identified by its task and change IDs.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredThe unique integer ID of the change request to retrieve the task from.
task_idintegerRequiredThe unique integer ID of the task to be retrieved from a Change request in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-change-task'.
#

FreshserviceApi.RetrieveProblemDetails

Retrieve details of a specific problem by ID. Use this tool to get detailed information about a problem in Freshservice by specifying its ID. Useful for retrieving specific problem data for analysis or reporting.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredID of the problem to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-problem'.
#

FreshserviceApi.RetrieveProblemNote

Retrieve a note on a Freshservice problem using IDs. Use this tool to get detailed information about a specific note associated with a problem in Freshservice by providing the problem and note IDs.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredThe unique integer ID of the note to be retrieved on the Freshservice problem.
problem_idintegerRequiredThe ID of the problem for which the note is being retrieved. It should be an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-problem-note'.
#

FreshserviceApi.RetrieveProblemNotes

Retrieve notes from a specific problem in Freshservice. Use this tool to get all notes associated with a specific problem in Freshservice by providing the problem's ID.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe integer ID of the problem for which notes will be retrieved from Freshservice.
notes_per_pageintegerOptionalSpecify the number of notes to retrieve per page in the paginated list.
page_number_to_retrieveintegerOptionalThe page number of notes to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-problem-notes'.
#

FreshserviceApi.RetrieveProblemTask

Retrieve a specific task from a problem in Freshservice. This tool retrieves the details of a task associated with a specific problem in Freshservice, using the problem and task IDs provided.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe unique identifier for the problem used to retrieve the task details from Freshservice.
task_idintegerRequiredID of the task to be retrieved from the specified problem, expected as an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-problem-task'.
#

FreshserviceApi.RetrieveProblemTimeEntry

Retrieve a time entry for a specific problem in Freshservice. Use this tool to get detailed information about a time entry associated with a specific problem in Freshservice when provided with the problem ID and time entry ID.

Parameters

ParameterTypeReq.Description
problem_idintegerRequiredThe unique identifier for the problem to retrieve the associated time entry.
time_entry_idintegerRequiredAn integer representing the ID of the specific time entry to be retrieved.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-problem-time-entry'.
#

FreshserviceApi.RetrievePurchaseOrder

Retrieve an existing purchase order by ID. Fetch the details of an existing purchase order using its unique identifier. This tool should be called when purchase order information is needed.

Parameters

ParameterTypeReq.Description
purchase_order_idintegerRequiredThe unique identifier of the purchase order to retrieve. This must be an integer value.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-purchase-order'.
#

FreshserviceApi.RetrieveReleaseTimeEntry

Retrieve a specific time entry from a release. Use this tool to obtain details about a specific time entry associated with a release in Freshservice, using the release and time entry IDs.

Parameters

ParameterTypeReq.Description
release_idintegerRequiredThe unique integer ID of the release for which you want to retrieve the time entry. Ensure it corresponds to an existing release in Freshservice.
time_entry_idintegerRequiredThe unique ID of the time entry to be retrieved from a specific release.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-release-time-entry'.
#

FreshserviceApi.RetrieveSolutionFolders

Retrieve all solution folders from Freshservice. Use this tool to get a list of all solution folders available in Freshservice. Useful for organizing or managing solution articles.

Parameters

ParameterTypeReq.Description
entries_per_pageintegerOptionalThe number of solution folder entries to retrieve per page.
pagination_page_numberintegerOptionalSpecify the page number to retrieve in a paginated list of solution folders.
solution_category_idintegerOptionalID of the solution category where the folders reside. This specifies which category's folders to retrieve.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-solution-folders'.
#

FreshserviceApi.RetrieveSpecificSoftware

Fetch details of a specific software application from Freshservice.

Parameters

ParameterTypeReq.Description
software_application_idintegerRequiredThe unique integer identifier for the software application in Freshservice that you want to retrieve.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-application'.
#

FreshserviceApi.RetrieveTicketTask

Retrieve a specific task from a ticket request. Use this tool to get information about a task associated with a specific ticket in Freshservice by providing the ticket and task IDs.

Parameters

ParameterTypeReq.Description
task_idintegerRequiredThe unique integer ID of the task to retrieve from the ticket request.
ticket_request_idintegerRequiredThe unique integer ID of the ticket request in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-ticket-task'.
#

FreshserviceApi.RetrieveTicketTasks

Retrieve tasks for a specific ticket ID. This tool is used to fetch the list of tasks associated with a specific ticket request from Freshservice, using the ticket ID.

Parameters

ParameterTypeReq.Description
ticket_request_idintegerRequiredThe unique ID of the ticket request to retrieve associated tasks from Freshservice.
page_number_to_retrieveintegerOptionalThe page number of tasks to retrieve from the paginated list.
tasks_per_pageintegerOptionalSpecify the number of tasks to retrieve per page in a paginated response.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'list-ticket-tasks'.
#

FreshserviceApi.RetrieveVendorDetails

Retrieve details of a specific vendor by ID. This tool fetches detailed information about a specific vendor using their vendor ID. It should be called when you need to access vendor information stored in Freshservice.

Parameters

ParameterTypeReq.Description
vendor_idintegerRequiredThe unique integer ID of the vendor to retrieve details for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-vendor'.
#

FreshserviceApi.UpdateAgentGroup

Update an existing Agent Group in Freshservice. This tool updates an existing agent group in Freshservice. It should be called when modifications to group details are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
agent_group_idintegerOptionalThe unique identifier of the agent group to update. This should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-agent-group'.
#

FreshserviceApi.UpdateAssetComponent

Update a specific component within an asset. This tool updates a specified component within an asset in Freshservice. Use it to modify details of an existing component in an asset by providing the asset's display ID and the component's ID.

Parameters

ParameterTypeReq.Description
asset_display_idintegerRequiredThe unique display ID of the asset where the component is being updated. This is required to identify the specific asset in Freshservice.
component_idintegerRequiredThe unique identifier for the component to update within the asset. This should be an integer representing the component's ID.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-asset-component'.
#

FreshserviceApi.UpdateAssetType

Update an existing asset type in Freshservice. Use this tool to update information about an existing asset type within the Freshservice platform. The asset type to be updated is identified by its asset_type_id.

Parameters

ParameterTypeReq.Description
asset_type_idintegerRequiredUnique identifier of the asset type to be updated.
asset_idintegerOptionalUnique identifier of the asset type to be updated.
asset_type_description_htmlstringOptionalProvide a short HTML-formatted description of the asset type.
asset_type_namestringOptionalThe new name for the asset type to be updated.
parent_asset_type_idintegerOptionalUnique identifier for the parent asset type to establish hierarchy.
plain_text_descriptionstringOptionalProvide a short plain text description of the asset type. Avoid using HTML or special formatting.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-asset-type'.
#

FreshserviceApi.UpdateCannedResponse

Update a canned response in Freshservice. Use this tool to update an existing canned response in Freshservice. It modifies the details of a specific canned response identified by its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
canned_response_idintegerOptionalThe ID of the canned response you wish to update. This should be an integer value that uniquely identifies the response within Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-canned-response'.
#

FreshserviceApi.UpdateCannedResponseFolder

Update an existing Canned Response Folder in Freshservice. Use this tool to modify details of a specific canned response folder in Freshservice by providing the folder ID and required updates.

Parameters

ParameterTypeReq.Description
canned_response_folder_idintegerRequiredThe ID of the canned response folder to update in Freshservice. This is required to identify which folder needs modification.
folder_creation_datestringOptionalThe date and time the canned response folder was originally created. Expected format is ISO 8601 (e.g., '2023-10-12T10:20:30Z').
folder_namestringOptionalThe new name for the canned response folder. This will replace the current name.
folder_responses_countintegerOptionalSpecifies the number of responses in the canned response folder to update.
folder_typestringOptionalSpecify the type of the canned response folder. This may relate to its category or purpose.
last_updated_timestampstringOptionalThe timestamp of when the folder was last updated. Expected in ISO 8601 format.
new_folder_idintegerOptionalThe new ID to assign to the canned response folder. This should be an integer.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-canned-response-folder'.
#

FreshserviceApi.UpdateChangeNote

Update an existing note on a Freshservice change request. Use this tool to modify an existing note on a specific change request in Freshservice by providing the change and note IDs.

Parameters

ParameterTypeReq.Description
change_request_idintegerRequiredUnique identifier for the change request to be updated.
note_idintegerRequiredThe ID of the existing note to be updated. Provide the unique integer identifier for the note.
note_body_htmlstringOptionalThe body of the note in HTML format. Use HTML tags to style the content appropriately.
note_body_textstringOptionalThe content of the note in plain text format to be updated.
note_creation_timestringOptionalDate and time when the note was created; format should follow ISO 8601 standard.
note_unique_idintegerOptionalThe unique identifier for the specific note to be updated.
note_updated_datetimestringOptionalThe date and time when the note was last updated. Use ISO 8601 format.
notification_email_addressesarray<string>OptionalEmail addresses to notify about the updated note. Provide as an array of strings.
user_id_of_note_creatorintegerOptionalUnique ID of the user who originally created the note. Used to identify the note's author.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-change-note'.
#

FreshserviceApi.UpdateChangeRequest

Update an existing Change request in Freshservice. Use this tool to modify the details of an existing Change request in Freshservice. Useful for updating information or status of Change requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
change_request_idintegerOptionalThe unique identifier for the Change request to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-change'.
#

FreshserviceApi.UpdateCsatSurvey

Update an existing CSAT Survey in Freshservice. Use this tool to modify and update the content or settings of an existing CSAT Survey in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
survey_idintegerOptionalThe unique ID of the CSAT Survey to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-survey'.
#

FreshserviceApi.UpdateExistingAgent

Update an existing agent in Freshservice. Use this tool to modify details of an existing agent in the Freshservice platform. It's suitable when you need to change agent information such as name, email, or role. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
agent_identifierintegerOptionalID of the agent to be updated in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-agent'.
#

FreshserviceApi.UpdateExistingAsset

Update the details of an existing asset in Freshservice. Use this tool to modify the information of an existing asset by its display ID in Freshservice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
asset_display_idintegerOptionalThe unique display ID of the asset to be updated in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-asset'.
#

FreshserviceApi.UpdateExistingChangeTask

Update a task within a Freshservice Change request. Use this tool to update an existing task on a Change request in Freshservice. It should be called when a task associated with a change needs to be modified, such as changing its status, description, or other attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
change_request_idintegerOptionalThe unique identifier for the Change request to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_identifierintegerOptionalThe unique ID of the task to be updated in the Freshservice Change request. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-change-task'.
#

FreshserviceApi.UpdateFreshserviceAnnouncement

Update an existing Freshservice announcement. Use this tool to modify an existing announcement in Freshservice. This is useful for updating content, title, or any other property of an announcement identified by its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
announcement_idintegerOptionalThe unique ID of the announcement to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-announcement'.
#

FreshserviceApi.UpdateFreshserviceChangeTimeEntry

Update a time entry on a Freshservice Change request. Use this tool to modify an existing time entry for a Change request in Freshservice, specifying the Change ID and the Time Entry ID to update. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
change_request_idintegerOptionalID of the change request to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
time_entry_identifierintegerOptionalProvide the integer ID of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-change-time-entry'.
#

FreshserviceApi.UpdateFreshserviceProblemTimeEntry

Update an existing time entry on a Freshservice problem. Use this tool to modify details of a time entry recorded on a specific problem within Freshservice. This is helpful for correcting or adjusting recorded time related to problem management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
problem_idintegerOptionalID of the problem whose time entry needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
time_entry_idintegerOptionalThe unique integer ID of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-problem-time-entry'.
#

FreshserviceApi.UpdateFreshserviceRelease

Update an existing Release in Freshservice. Use this tool to modify details of an existing release in Freshservice. This is useful for updating information such as release dates, descriptions, or status. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
release_idintegerOptionalThe unique ID of the release to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-release'.
#

FreshserviceApi.UpdateFreshserviceTicketTask

Update a task on a Freshservice ticket. Use this tool to update an existing task on a ticket in Freshservice. This is helpful for modifying task details such as status, description, or other properties associated with a ticket's task. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_idintegerOptionalThe ID of the ticket request to identify the specific ticket in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_idintegerOptionalThe unique ID of the task to be updated in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-ticket-task'.
#

FreshserviceApi.UpdateLocationInfo

Update an existing location's information in Freshservice. Use this tool to modify the details of an existing location in Freshservice. It should be called whenever there is a need to change location information, such as address or contact details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
location_identifierintegerOptionalThe unique integer ID of the location to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-location'.
#

FreshserviceApi.UpdateProblemNote

Update a note on an existing problem in Freshservice. This tool updates an existing note on a specified problem in Freshservice. Use this when you need to modify details or correct information in a note associated with a problem.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredID of the note to be updated.
problem_idintegerRequiredThe unique ID of the problem to update the note for.
creator_user_idintegerOptionalUnique ID of the user who originally created the note. This is necessary for update operations to ensure the note's authorship is correctly handled.
note_body_htmlstringOptionalThe body of the note in HTML format for updating an existing note.
note_body_textstringOptionalThe content of the note in plain text format for the problem note update.
note_created_datetimestringOptionalThe datetime when the note was initially created in ISO 8601 format (e.g., '2023-03-10T10:00:00Z').
note_unique_idintegerOptionalThe unique ID of the note to be updated.
note_update_datetimestringOptionalThe date and time at which the note was updated, in ISO 8601 format.
notification_email_addressesarray<string>OptionalList of email addresses to notify about the note update.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-problem-note'.
#

FreshserviceApi.UpdateProblemTask

Update an existing task on a Freshservice problem. This tool updates a specific task linked to an existing problem in Freshservice. Use it to modify details of a task within a problem context. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
problem_idintegerOptionalThe unique identifier for the problem to which the task is linked. This is an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_identifierintegerOptionalUnique integer identifier for the specific task to update within a problem in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-problem-task'.
#

FreshserviceApi.UpdateProductInCatalog

Update an existing product in the catalog. Use this tool to modify details of a product in the product catalog. Call this when a product's information needs to be updated.

Parameters

ParameterTypeReq.Description
product_unique_idintegerRequiredThe unique integer identifier for the product to be updated in the catalog.
asset_type_idintegerOptionalThe unique identifier for the asset type of the product. It should be an integer.
depreciation_type_descriptionstringOptionalA description of the depreciation type used for the product. Accepts textual information detailing the depreciation category or specifics.
depreciation_type_identifierintegerOptionalUnique identifier for the type of depreciation used for the product.
procurement_modeintegerOptionalSpecifies the mode of procurement: 1 for Buy, 2 for Lease, 3 for Both.
product_id_numberintegerOptionalUnique ID of the product to be updated in the catalog.
product_manufacturer_namestringOptionalThe name of the product's manufacturer. Provide as free text.
product_namestringOptionalThe name of the product to be updated in the catalog.
product_statusintegerOptionalSpecify the status of the product: `1` for In Production, `2` for In Pipeline, `3` for Retired.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-product'.
#

FreshserviceApi.UpdateProject

Update an existing project in Freshservice. Use this tool to modify details of an existing project in Freshservice. Ideal for changes or updates to project information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
project_idintegerOptionalThe unique identifier of the project to update. Must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-project'.
#

FreshserviceApi.UpdateProjectTask

Update an existing project task in Freshservice. This tool updates an existing project task in Freshservice. It should be called when modifications to task details are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
project_identifierintegerOptionalThe unique ID of the project containing the task to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_idintegerOptionalThe ID of the task to be updated in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-project-task'.
#

FreshserviceApi.UpdatePurchaseOrder

Update details of an existing purchase order. This tool updates an existing purchase order with new information. Call this tool when you need to modify purchase order details in the Freshservice system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
purchase_order_idintegerOptionalThe ID of the purchase order to update. It identifies which purchase order will be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-purchase-order'.
#

FreshserviceApi.UpdateReleaseNote

Update an existing release note in Freshservice. This tool updates an existing note on a specified release in Freshservice. Call this when you need to modify the content of a release note within the platform.

Parameters

ParameterTypeReq.Description
note_idintegerRequiredThe unique identifier of the note to be updated.
release_identifierintegerRequiredThe unique integer ID of the release to be updated.
note_body_plain_textstringOptionalThe content of the release note in plain text format, without any HTML tags.
note_created_datetimestringOptionalThe date and time when the note was initially created, in ISO 8601 format (e.g., YYYY-MM-DDTHH:MM:SSZ).
note_html_bodystringOptionalThe HTML content of the note to be updated. Use valid HTML format.
note_unique_idintegerOptionalThe unique ID of the note to update.
note_updated_atstringOptionalDate and time when the note was updated, in ISO 8601 format (e.g., '2023-03-27T14:00:00Z').
notification_email_addressesarray<string>OptionalAn array of email addresses to notify about the updated release note.
user_id_of_note_creatorintegerOptionalUnique ID of the user who created the note.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-release-note'.
#

FreshserviceApi.UpdateReleaseTask

Update a specific task within a release in Freshservice. Use this tool to modify details of a specific task associated with an existing release in Freshservice. This is useful when changes are needed in task descriptions, assignments, dates, or statuses within a release. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
release_idintegerOptionalThe numeric ID of the release containing the task to update. This ID is mandatory to locate the specific release. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_idintegerOptionalThe numeric ID of the task to be updated in the release. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-release-task'.
#

FreshserviceApi.UpdateReleaseTimeEntry

Update a time entry on a release in Freshservice. Use this tool to update an existing time entry associated with a specific release in Freshservice. It should be called when you need to modify details of a time entry for an already existing release. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
release_idintegerOptionalID of the release to be updated. Must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
time_entry_idintegerOptionalID of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-release-time-entry'.
#

FreshserviceApi.UpdateRequesterInFreshservice

Update an existing requester in Freshservice. Use this tool to modify details of an existing requester in Freshservice by specifying their unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
requester_id_to_updateintegerOptionalThe unique integer ID of the requester to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-requester'.
#

FreshserviceApi.UpdateServiceProblem

Update details of an existing problem in Freshservice. Use this tool to update information for a specific problem within the Freshservice platform by providing the necessary problem ID and details to modify. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
problem_idintegerOptionalThe integer ID of the problem to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-problem'.
#

FreshserviceApi.UpdateServiceRequest

Update an existing service request in Freshservice. Use this tool to update details of an existing service request in Freshservice when changes are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
service_request_idintegerOptionalThe unique integer ID of the service request that needs to be updated in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-service-request'.
#

FreshserviceApi.UpdateSolutionArticle

Update a Freshservice solution article by ID. This tool updates a solution article in Freshservice using the provided article ID. It should be called when you need to modify the details of an existing solution article. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
solution_article_idintegerOptionalThe ID of the Freshservice solution article to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-solution-article'.
#

FreshserviceApi.UpdateSolutionCategory

Update a solution category in Freshservice by ID. Use this tool to update a specific solution category in Freshservice by providing the category ID.

Parameters

ParameterTypeReq.Description
solution_category_idintegerRequiredThe ID of the solution category to be updated in Freshservice.
category_unique_idintegerOptionalUnique identifier of the solution category to update. It must be an integer.
is_default_categorybooleanOptionalIndicates if the solution category is a default one, which restricts modifications like adding folders, deletion, or renaming.
solution_category_descriptionstringOptionalProvide a description for the solution category being updated. This should be a brief textual summary.
solution_category_namestringOptionalThe new name for the solution category to be updated.
solution_category_positionintegerOptionalThe position of the solution category in the category listing. Determines the order when there are multiple categories.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-solution-category'.
#

FreshserviceApi.UpdateSolutionFolder

Update a solution folder in Freshservice by ID. Use this tool to update a specific solution folder in Freshservice by providing the folder ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
solution_folder_idintegerOptionalID of the solution folder to update in Freshservice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-solution-folder'.
#

FreshserviceApi.UpdateTicketTimeEntry

Update time entry for a ticket in Freshservice. Use this tool to update an existing time entry on a ticket in Freshservice. It's suitable for modifying the details of time tracked on support tickets to ensure accurate record-keeping. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
ticket_request_idintegerOptionalThe unique integer ID of the ticket request to update the time entry for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
time_entry_idintegerOptionalThe unique integer ID of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-ticket-time-entry'.
#

FreshserviceApi.UpdateVendorInfo

Update details of an existing vendor. Use this tool to update information for an existing vendor in the Freshservice system, using the vendor ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
vendor_identifierintegerOptionalThe unique identifier for the vendor to be updated. It must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'update-vendor'.
#

FreshserviceApi.ViewProjectTaskDetails

Retrieve details of a specific project task. Use this tool to view detailed information about a task within a specified project on Freshservice. Ideal for retrieving task status, assignees, or due dates.

Parameters

ParameterTypeReq.Description
project_id_for_taskintegerRequiredThe unique identifier of the project to which the task belongs.
task_idintegerRequiredThe unique identifier for the task you want to retrieve details for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-project-task'.
#

FreshserviceApi.ViewServiceItem

View a service item's details using its ID. Use this tool to retrieve and view details of a specific service item by providing its ID. Call this tool when you need information about a service item from Freshservice.

Parameters

ParameterTypeReq.Description
service_item_identifierintegerRequiredThe ID of the service item you want to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-service-item'.
#

FreshserviceApi.ViewSolutionArticle

Retrieve details of a solution article by ID in Freshservice. Use this tool to view detailed information of a specific solution article in Freshservice. Provide the article ID to retrieve the content and metadata of the article.

Parameters

ParameterTypeReq.Description
solution_article_idintegerRequiredThe unique ID of the solution article to retrieve from Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-solution-article'.
#

FreshserviceApi.ViewSolutionCategory

Retrieve details of a specific solution category. Use this tool to view and retrieve details about a specific solution category using its ID.

Parameters

ParameterTypeReq.Description
solution_category_idintegerRequiredThe unique ID of the solution category to retrieve details for.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-solution-category'.
#

FreshserviceApi.ViewSolutionFolder

Retrieve details of a specific solution folder in Freshservice. Use this tool to obtain information about a specific solution folder within Freshservice by providing the folder ID. It returns detailed data about the folder, which can be useful for managing and organizing IT solutions.

Parameters

ParameterTypeReq.Description
solution_folder_idintegerRequiredProvide the integer ID of the solution folder you wish to view in Freshservice.

Requirements

Secrets:FRESHSERVICE_SUBDOMAINFRESHSERVICE_API_KEY

Output

Type:json— Response from the API endpoint 'get-solution-folder'.
Last updated on