Skip to main content
Server path: /freshservice-tickets | Type: Application | PCID required: Yes

Tools

ToolDescription
freshservice_tickets_add_ticket_noteCreate a Note on a Ticket
freshservice_tickets_cancel_ticket_approvalCancel a Ticket Approval
freshservice_tickets_create_child_ticketCreate Child Ticket
freshservice_tickets_create_ticketCreate a Ticket
freshservice_tickets_create_ticket_taskCreate a Ticket Task
freshservice_tickets_create_ticket_time_entryCreate a Ticket Time Entry
freshservice_tickets_delete_conversationDelete a Conversation
freshservice_tickets_delete_ticketDelete a Ticket (trash)
freshservice_tickets_delete_ticket_attachmentDelete Ticket Attachment
freshservice_tickets_delete_ticket_taskDelete a Ticket Task
freshservice_tickets_delete_ticket_time_entryDelete a Ticket Time Entry
freshservice_tickets_filter_ticketsFilter Tickets
freshservice_tickets_get_ticketView a Ticket
freshservice_tickets_get_ticket_activitiesGet Ticket Activity
freshservice_tickets_get_ticket_approvalView a Ticket Approval
freshservice_tickets_get_ticket_csat_responseView CSAT Response
freshservice_tickets_get_ticket_taskView a Ticket Task
freshservice_tickets_get_ticket_time_entryView a Ticket Time Entry
freshservice_tickets_list_ticket_approvalsList Ticket Approvals
freshservice_tickets_list_ticket_conversationsList All Conversations of a Ticket
freshservice_tickets_list_ticket_fieldsList All Ticket Fields
freshservice_tickets_list_ticket_tasksList All Ticket Tasks
freshservice_tickets_list_ticket_time_entriesList All Ticket Time Entries
freshservice_tickets_list_ticketsList All Tickets
freshservice_tickets_reply_to_ticketReply to a Ticket
freshservice_tickets_request_ticket_approvalRequest Approval on a Ticket
freshservice_tickets_restore_ticketRestore a Trashed Ticket
freshservice_tickets_update_conversationUpdate a Conversation
freshservice_tickets_update_ticketUpdate a Ticket
freshservice_tickets_update_ticket_taskUpdate a Ticket Task
freshservice_tickets_update_ticket_time_entryUpdate a Ticket Time Entry

freshservice_tickets_add_ticket_note

Create a Note on a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
bodystringYesNote HTML body
notify_emailsstring[]NoEmails to notify
privatebooleanNoPrivate note (default true)

freshservice_tickets_cancel_ticket_approval

Cancel a Ticket Approval Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
approval_idintegerYesApproval ID

freshservice_tickets_create_child_ticket

Create Child Ticket Parameters:
ParameterTypeRequiredDefaultDescription
parent_idintegerYesParent ticket ID
descriptionstringNoThe description value
emailstringNoRequester email
priorityintegerNoThe priority value
statusintegerNoThe status value
subjectstringYesThe subject value

freshservice_tickets_create_ticket

Create a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
assetsobject[]NoAssociated assets
categorystringNoThe category value
cc_emailsstring[]NoCC email addresses
custom_fieldsobjectNoCustom field key-value pairs
department_idintegerNoDepartment ID
descriptionstringNoHTML description
due_bystringNoResolution due (ISO 8601)
emailstringNoRequester email
fr_due_bystringNoFirst response due (ISO 8601)
group_idintegerNoAssigned group ID
impactintegerNoImpact level
item_categorystringNoItem category
namestringNoRequester name
phonestringNoRequester phone
priorityintegerNo1=Low, 2=Medium, 3=High, 4=Urgent
requester_idintegerNoRequester user ID
responder_idintegerNoAssigned agent ID
sourceintegerNo1=Email, 2=Portal, 3=Phone, 4=Chat, 7=Feedback Widget
statusintegerNo2=Open, 3=Pending, 4=Resolved, 5=Closed
sub_categorystringNoSub-category
subjectstringYesTicket subject
tagsstring[]NoThe tags value
typestringNoIncident, Service Request, etc.
urgencyintegerNoUrgency level
workspace_idintegerNoWorkspace ID

freshservice_tickets_create_ticket_task

Create a Ticket Task Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
agent_idintegerNoAssigned agent ID
descriptionstringNoTask description
due_datestringNoDue date (ISO 8601)
group_idintegerNoAssigned group ID
notify_beforeintegerNoSeconds before due date to notify
statusintegerNo1=Open, 2=In Progress, 3=Completed
titlestringYesTask title

freshservice_tickets_create_ticket_time_entry

Create a Ticket Time Entry Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
agent_idintegerYesAgent ID (mandatory)
billablebooleanNoBillable entry (default true)
executed_atstringNoWhen work was done (ISO 8601)
notestringNoDescription of work
start_timestringNoStart time (ISO 8601)
task_idintegerNoAssociated task ID
time_spentstringNoTime spent in hh:mm format

freshservice_tickets_delete_conversation

Delete a Conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID

freshservice_tickets_delete_ticket

Delete a Ticket (trash) Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID

freshservice_tickets_delete_ticket_attachment

Delete Ticket Attachment Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
attachment_idintegerYesAttachment ID

freshservice_tickets_delete_ticket_task

Delete a Ticket Task Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
task_idintegerYesTask ID

freshservice_tickets_delete_ticket_time_entry

Delete a Ticket Time Entry Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
time_entry_idintegerYesTime Entry ID

freshservice_tickets_filter_tickets

Filter Tickets Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesFilter query, e.g. asset_type_id:1 — do NOT include surrounding quotes, they are added automatically
workspace_idintegerNoWorkspace ID
pageintegerNoPage number
per_pageintegerNoItems per page (max 100)

freshservice_tickets_get_ticket

View a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
includestringNoInclude: conversations, requester, requested_for, stats, problem, assets, changes, related_tickets, tags

freshservice_tickets_get_ticket_activities

Get Ticket Activity Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID

freshservice_tickets_get_ticket_approval

View a Ticket Approval Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
approval_idintegerYesApproval ID

freshservice_tickets_get_ticket_csat_response

View CSAT Response Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID

freshservice_tickets_get_ticket_task

View a Ticket Task Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
task_idintegerYesTask ID

freshservice_tickets_get_ticket_time_entry

View a Ticket Time Entry Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
time_entry_idintegerYesTime Entry ID

freshservice_tickets_list_ticket_approvals

List Ticket Approvals Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID

freshservice_tickets_list_ticket_conversations

List All Conversations of a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
pageintegerNoPage number
per_pageintegerNoItems per page (max 100)

freshservice_tickets_list_ticket_fields

List All Ticket Fields Parameters:
ParameterTypeRequiredDefaultDescription
workspace_idintegerNoWorkspace ID

freshservice_tickets_list_ticket_tasks

List All Ticket Tasks Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
pageintegerNoPage number
per_pageintegerNoItems per page (max 100)

freshservice_tickets_list_ticket_time_entries

List All Ticket Time Entries Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
pageintegerNoPage number
per_pageintegerNoItems per page (max 100)

freshservice_tickets_list_tickets

List All Tickets Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoItems per page (max 100)
filterstringNoPredefined filter: new_and_my_open, watching, spam, deleted
requester_idintegerNoFilter by requester ID
emailstringNoFilter by requester email
updated_sincestringNoFilter by last update (ISO 8601)
typestringNoFilter by ticket type
workspace_idintegerNoFilter by workspace
order_typestringNoasc or desc
includestringNoInclude: stats, requester, requested_for

freshservice_tickets_reply_to_ticket

Reply to a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
bcc_emailsstring[]NoBCC emails
bodystringYesReply HTML body
cc_emailsstring[]NoCC emails
from_emailstringNoSender email

freshservice_tickets_request_ticket_approval

Request Approval on a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
approval_typeintegerNo1=Everyone must approve, 2=Anyone can approve
approver_idintegerNoApprover agent ID

freshservice_tickets_restore_ticket

Restore a Trashed Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID

freshservice_tickets_update_conversation

Update a Conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
bodystringNoUpdated HTML body

freshservice_tickets_update_ticket

Update a Ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
categorystringNoThe category value
custom_fieldsobjectNoCustom fields
department_idintegerNoDepartment ID
descriptionstringNoHTML description
due_bystringNoResolution due
fr_due_bystringNoFirst response due
group_idintegerNoAssigned group ID
impactintegerNoThe impact value
item_categorystringNoItem category
priorityintegerNo1=Low, 2=Medium, 3=High, 4=Urgent
responder_idintegerNoAssigned agent ID
sourceintegerNoThe source value
statusintegerNo2=Open, 3=Pending, 4=Resolved, 5=Closed
sub_categorystringNoSub-category
subjectstringNoThe subject value
tagsstring[]NoThe tags value
typestringNoTicket type
urgencyintegerNoThe urgency value

freshservice_tickets_update_ticket_task

Update a Ticket Task Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
task_idintegerYesTask ID
agent_idintegerNoAssigned agent
descriptionstringNoThe description value
due_datestringNoDue date
group_idintegerNoAssigned group
statusintegerNoThe status value
titlestringNoThe title value

freshservice_tickets_update_ticket_time_entry

Update a Ticket Time Entry Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesTicket ID
time_entry_idintegerYesTime Entry ID
agent_idintegerNoAgent ID
billablebooleanNoThe billable value
executed_atstringNoExecution time
notestringNoDescription
time_spentstringNoTime in hh:mm