Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /freshservice | Type: Application | PCID required: Yes

Tools

ToolDescription
freshservice_add_ticket_noteAdd a note to a ticket
freshservice_create_agentCreate an agent
freshservice_create_assetCreate an asset
freshservice_create_changeCreate a change request
freshservice_create_departmentCreate a department
freshservice_create_problemCreate a problem
freshservice_create_requesterCreate a requester
freshservice_create_ticketCreate a new ticket
freshservice_delete_ticketDelete a ticket
freshservice_get_assetGet an asset
freshservice_get_ticketGet a ticket
freshservice_list_agent_groupsList all agent groups
freshservice_list_agentsList all agents
freshservice_list_assetsList all assets
freshservice_list_changesList all changes
freshservice_list_departmentsList all departments
freshservice_list_locationsList all locations
freshservice_list_problemsList all problems
freshservice_list_requestersList all requesters
freshservice_list_service_catalog_itemsList service catalog items
freshservice_list_ticket_conversationsList conversations of a ticket
freshservice_list_ticketsList all tickets
freshservice_reply_to_ticketReply to a ticket
freshservice_search_assetsDEPRECATED — Search assets by query. Use list_assets with the query parameter instead.
freshservice_update_assetUpdate an asset
freshservice_update_ticketUpdate a ticket

freshservice_add_ticket_note

Add a note to a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket
bodystringYesHTML content of the note
notify_emailsstring[]NoEmail addresses to notify
privatebooleanNoWhether the note is private (default: true)

freshservice_create_agent

Create an agent Parameters:
ParameterTypeRequiredDefaultDescription
department_idsinteger[]NoDepartment IDs
emailstringYesEmail address (must be unique)
first_namestringNoFirst name
group_idsinteger[]NoGroup IDs
job_titlestringNoJob title
last_namestringNoLast name
location_idintegerNoLocation ID
mobile_phone_numberstringNoMobile phone number
occasionalbooleanNoWhether the agent is occasional (true) or full-time (false)
phonestringNoPhone number
role_idsinteger[]NoRole IDs

freshservice_create_asset

Create an asset Parameters:
ParameterTypeRequiredDefaultDescription
agent_idintegerNoID of the agent managing the asset
asset_tagstringNoAsset tag identifier
asset_type_idintegerYesID of the asset type
assigned_onstringNoDate when asset was assigned
department_idintegerNoID of the department
descriptionstringNoDescription of the asset
group_idintegerNoID of the agent group
impactstringNoImpact level (low, medium, high)
location_idintegerNoID of the location
namestringYesName of the asset
usage_typestringNoUsage type (permanent, loaner)
user_idintegerNoID of the user associated with the asset

freshservice_create_change

Create a change request Parameters:
ParameterTypeRequiredDefaultDescription
agent_idintegerNoID of the agent
categorystringNoThe category value
change_typeintegerYesType: 1=Minor, 2=Standard, 3=Major, 4=Emergency
descriptionstringNoDescription in HTML
impactintegerYesImpact: 1=Low, 2=Medium, 3=High
planned_end_datestringYesPlanned end date
planned_start_datestringYesPlanned start date
priorityintegerYesPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
requester_idintegerYesID of the requester
riskintegerYesRisk: 1=Low, 2=Medium, 3=High, 4=Very High
statusintegerNoStatus: 1=Open, 2=Planning, 3=Awaiting Approval, 4=Pending Release, 5=Pending Review, 6=Closed
sub_categorystringNoSub-category
subjectstringYesSubject of the change

freshservice_create_department

Create a department Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
domainsstring[]NoEmail domains associated with the department
head_user_idintegerNoID of the department head
namestringYesName of the department
prime_user_idintegerNoID of the primary contact

freshservice_create_problem

Create a problem Parameters:
ParameterTypeRequiredDefaultDescription
agent_idintegerNoID of the agent
categorystringNoThe category value
descriptionstringNoDescription in HTML
due_bystringNoDue date
group_idintegerNoGroup ID
impactintegerYesImpact: 1=Low, 2=Medium, 3=High
item_categorystringNoItem category
known_errorbooleanNoWhether this is a known error
priorityintegerYesPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
requester_idintegerYesID of the requester
statusintegerYesStatus: 1=Open, 2=Change Requested, 3=Closed
sub_categorystringNoSub-category
subjectstringYesSubject of the problem

freshservice_create_requester

Create a requester Parameters:
ParameterTypeRequiredDefaultDescription
department_idsinteger[]NoDepartment IDs
emailstringNoPrimary email of the requester
first_namestringYesFirst name of the requester
job_titlestringNoJob title
languagestringNoLanguage preference
last_namestringNoLast name of the requester
location_idintegerNoLocation ID
mobile_phone_numberstringNoMobile phone number
phonestringNoPhone number
time_zonestringNoTime zone

freshservice_create_ticket

Create a new ticket Parameters:
ParameterTypeRequiredDefaultDescription
categorystringNoCategory of the ticket
descriptionstringYesHTML content of the ticket
due_bystringNoTicket due date
emailstringNoEmail of the requester. If no contact exists with this email, a new one is created.
fr_due_bystringNoFirst response due date
group_idintegerNoID of the group to which the ticket is assigned
impactintegerNoImpact: 1=Low, 2=Medium, 3=High
item_categorystringNoItem category of the ticket
phonestringNoPhone number of the requester
priorityintegerYesPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
requester_idintegerNoID of the requester. Must be an existing contact.
responder_idintegerNoID of the agent to whom the ticket is assigned
sourceintegerNoSource: 1=Email, 2=Portal, 3=Phone, 4=Chat, 5=Feedback Widget, 6=Yammer, 7=AWS Cloudwatch, 8=Pagerduty, 9=Walkup, 10=Slack
statusintegerYesStatus: 2=Open, 3=Pending, 4=Resolved, 5=Closed
sub_categorystringNoSub-category of the ticket
subjectstringYesTicket subject
tagsstring[]NoTags for the ticket
typestringNoTicket type (e.g., ‘Incident’, ‘Service Request’)
urgencyintegerNoUrgency: 1=Low, 2=Medium, 3=High
workspace_idintegerNoWorkspace ID

freshservice_delete_ticket

Delete a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket

freshservice_get_asset

Get an asset Parameters:
ParameterTypeRequiredDefaultDescription
asset_display_idintegerYesDisplay ID of the asset

freshservice_get_ticket

Get a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket
includestringNoInclude additional information (e.g., ‘requester’, ‘stats’, ‘conversations’, ‘tags’)

freshservice_list_agent_groups

List all agent groups Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_agents

List all agents Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter by email
activebooleanNoFilter by active status
statestringNoFilter by state (fulltime, occasional)
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_assets

List all assets Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)
includestringNoInclude additional info (e.g., ‘type_fields’)
querystringNoSearch query to filter assets (e.g., “name:‘Dell Laptop’“)

freshservice_list_changes

List all changes Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoPredefined filter
updated_sincestringNoFilter changes updated since date
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_departments

List all departments Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_locations

List all locations Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_problems

List all problems Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_requesters

List all requesters Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter by email address
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_service_catalog_items

List service catalog items Parameters:
ParameterTypeRequiredDefaultDescription
category_idintegerNoFilter by category ID
pageintegerNoPage number
per_pageintegerNoRecords per page (max 100)

freshservice_list_ticket_conversations

List conversations of a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket

freshservice_list_tickets

List all tickets Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoFilter criteria for tickets (e.g., ‘new_and_my_open’, ‘watching’, ‘spam’, ‘deleted’)
requester_idintegerNoFilter tickets by requester ID
emailstringNoFilter tickets by requester email
updated_sincestringNoFilter tickets updated since this date (ISO 8601 format)
typestringNoFilter by ticket type (e.g., ‘Incident’, ‘Service Request’)
order_bystringNoSort field (e.g., ‘created_at’, ‘due_by’, ‘updated_at’)
order_typestringNoSort direction: ‘asc’ or ‘desc’
pageintegerNoPage number for pagination
per_pageintegerNoNumber of records per page (max 100)
includestringNoInclude additional information (e.g., ‘requester’, ‘stats’, ‘tags’)

freshservice_reply_to_ticket

Reply to a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket
bcc_emailsstring[]NoBCC email addresses
bodystringYesHTML content of the reply
cc_emailsstring[]NoCC email addresses
from_emailstringNoEmail address from which the reply is sent

freshservice_search_assets

DEPRECATED — Search assets by query. Use list_assets with the query parameter instead. Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesSearch query to filter assets (e.g., “name:‘Dell Laptop’“)

freshservice_update_asset

Update an asset Parameters:
ParameterTypeRequiredDefaultDescription
asset_display_idintegerYesDisplay ID of the asset
agent_idintegerNoAgent ID
asset_tagstringNoAsset tag
asset_type_idintegerNoAsset type ID
department_idintegerNoDepartment ID
descriptionstringNoThe description value
group_idintegerNoGroup ID
impactstringNoImpact level
location_idintegerNoLocation ID
namestringNoName of the asset
usage_typestringNoUsage type
user_idintegerNoUser ID

freshservice_update_ticket

Update a ticket Parameters:
ParameterTypeRequiredDefaultDescription
ticket_idintegerYesID of the ticket
categorystringNoTicket category
descriptionstringNoHTML content of the ticket
due_bystringNoDue date
fr_due_bystringNoFirst response due date
group_idintegerNoGroup ID
impactintegerNoImpact level
item_categorystringNoItem category
priorityintegerNoPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
responder_idintegerNoAgent ID
sourceintegerNoSource channel
statusintegerNoStatus: 2=Open, 3=Pending, 4=Resolved, 5=Closed
sub_categorystringNoSub-category
subjectstringNoTicket subject
tagsstring[]NoThe tags value
typestringNoTicket type
urgencyintegerNoUrgency level