Server path: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.
/freshservice | Type: Application | PCID required: Yes
Tools
freshservice_add_ticket_note
Add a note to a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
body | string | Yes | — | HTML content of the note |
notify_emails | string[] | No | — | Email addresses to notify |
private | boolean | No | — | Whether the note is private (default: true) |
freshservice_create_agent
Create an agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
department_ids | integer[] | No | — | Department IDs |
email | string | Yes | — | Email address (must be unique) |
first_name | string | No | — | First name |
group_ids | integer[] | No | — | Group IDs |
job_title | string | No | — | Job title |
last_name | string | No | — | Last name |
location_id | integer | No | — | Location ID |
mobile_phone_number | string | No | — | Mobile phone number |
occasional | boolean | No | — | Whether the agent is occasional (true) or full-time (false) |
phone | string | No | — | Phone number |
role_ids | integer[] | No | — | Role IDs |
freshservice_create_asset
Create an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | integer | No | — | ID of the agent managing the asset |
asset_tag | string | No | — | Asset tag identifier |
asset_type_id | integer | Yes | — | ID of the asset type |
assigned_on | string | No | — | Date when asset was assigned |
department_id | integer | No | — | ID of the department |
description | string | No | — | Description of the asset |
group_id | integer | No | — | ID of the agent group |
impact | string | No | — | Impact level (low, medium, high) |
location_id | integer | No | — | ID of the location |
name | string | Yes | — | Name of the asset |
usage_type | string | No | — | Usage type (permanent, loaner) |
user_id | integer | No | — | ID of the user associated with the asset |
freshservice_create_change
Create a change request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | integer | No | — | ID of the agent |
category | string | No | — | The category value |
change_type | integer | Yes | — | Type: 1=Minor, 2=Standard, 3=Major, 4=Emergency |
description | string | No | — | Description in HTML |
impact | integer | Yes | — | Impact: 1=Low, 2=Medium, 3=High |
planned_end_date | string | Yes | — | Planned end date |
planned_start_date | string | Yes | — | Planned start date |
priority | integer | Yes | — | Priority: 1=Low, 2=Medium, 3=High, 4=Urgent |
requester_id | integer | Yes | — | ID of the requester |
risk | integer | Yes | — | Risk: 1=Low, 2=Medium, 3=High, 4=Very High |
status | integer | No | — | Status: 1=Open, 2=Planning, 3=Awaiting Approval, 4=Pending Release, 5=Pending Review, 6=Closed |
sub_category | string | No | — | Sub-category |
subject | string | Yes | — | Subject of the change |
freshservice_create_department
Create a department Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description value |
domains | string[] | No | — | Email domains associated with the department |
head_user_id | integer | No | — | ID of the department head |
name | string | Yes | — | Name of the department |
prime_user_id | integer | No | — | ID of the primary contact |
freshservice_create_problem
Create a problem Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | integer | No | — | ID of the agent |
category | string | No | — | The category value |
description | string | No | — | Description in HTML |
due_by | string | No | — | Due date |
group_id | integer | No | — | Group ID |
impact | integer | Yes | — | Impact: 1=Low, 2=Medium, 3=High |
item_category | string | No | — | Item category |
known_error | boolean | No | — | Whether this is a known error |
priority | integer | Yes | — | Priority: 1=Low, 2=Medium, 3=High, 4=Urgent |
requester_id | integer | Yes | — | ID of the requester |
status | integer | Yes | — | Status: 1=Open, 2=Change Requested, 3=Closed |
sub_category | string | No | — | Sub-category |
subject | string | Yes | — | Subject of the problem |
freshservice_create_requester
Create a requester Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
department_ids | integer[] | No | — | Department IDs |
email | string | No | — | Primary email of the requester |
first_name | string | Yes | — | First name of the requester |
job_title | string | No | — | Job title |
language | string | No | — | Language preference |
last_name | string | No | — | Last name of the requester |
location_id | integer | No | — | Location ID |
mobile_phone_number | string | No | — | Mobile phone number |
phone | string | No | — | Phone number |
time_zone | string | No | — | Time zone |
freshservice_create_ticket
Create a new ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category | string | No | — | Category of the ticket |
description | string | Yes | — | HTML content of the ticket |
due_by | string | No | — | Ticket due date |
email | string | No | — | Email of the requester. If no contact exists with this email, a new one is created. |
fr_due_by | string | No | — | First response due date |
group_id | integer | No | — | ID of the group to which the ticket is assigned |
impact | integer | No | — | Impact: 1=Low, 2=Medium, 3=High |
item_category | string | No | — | Item category of the ticket |
phone | string | No | — | Phone number of the requester |
priority | integer | Yes | — | Priority: 1=Low, 2=Medium, 3=High, 4=Urgent |
requester_id | integer | No | — | ID of the requester. Must be an existing contact. |
responder_id | integer | No | — | ID of the agent to whom the ticket is assigned |
source | integer | No | — | Source: 1=Email, 2=Portal, 3=Phone, 4=Chat, 5=Feedback Widget, 6=Yammer, 7=AWS Cloudwatch, 8=Pagerduty, 9=Walkup, 10=Slack |
status | integer | Yes | — | Status: 2=Open, 3=Pending, 4=Resolved, 5=Closed |
sub_category | string | No | — | Sub-category of the ticket |
subject | string | Yes | — | Ticket subject |
tags | string[] | No | — | Tags for the ticket |
type | string | No | — | Ticket type (e.g., ‘Incident’, ‘Service Request’) |
urgency | integer | No | — | Urgency: 1=Low, 2=Medium, 3=High |
workspace_id | integer | No | — | Workspace ID |
freshservice_delete_ticket
Delete a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
freshservice_get_asset
Get an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_display_id | integer | Yes | — | Display ID of the asset |
freshservice_get_ticket
Get a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
include | string | No | — | Include additional information (e.g., ‘requester’, ‘stats’, ‘conversations’, ‘tags’) |
freshservice_list_agent_groups
List all agent groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_agents
List all agents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter by email |
active | boolean | No | — | Filter by active status |
state | string | No | — | Filter by state (fulltime, occasional) |
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_assets
List all assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
include | string | No | — | Include additional info (e.g., ‘type_fields’) |
query | string | No | — | Search query to filter assets (e.g., “name:‘Dell Laptop’“) |
freshservice_list_changes
List all changes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Predefined filter |
updated_since | string | No | — | Filter changes updated since date |
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_departments
List all departments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_locations
List all locations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_problems
List all problems Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_requesters
List all requesters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter by email address |
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_service_catalog_items
List service catalog items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | integer | No | — | Filter by category ID |
page | integer | No | — | Page number |
per_page | integer | No | — | Records per page (max 100) |
freshservice_list_ticket_conversations
List conversations of a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
freshservice_list_tickets
List all tickets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Filter criteria for tickets (e.g., ‘new_and_my_open’, ‘watching’, ‘spam’, ‘deleted’) |
requester_id | integer | No | — | Filter tickets by requester ID |
email | string | No | — | Filter tickets by requester email |
updated_since | string | No | — | Filter tickets updated since this date (ISO 8601 format) |
type | string | No | — | Filter by ticket type (e.g., ‘Incident’, ‘Service Request’) |
order_by | string | No | — | Sort field (e.g., ‘created_at’, ‘due_by’, ‘updated_at’) |
order_type | string | No | — | Sort direction: ‘asc’ or ‘desc’ |
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of records per page (max 100) |
include | string | No | — | Include additional information (e.g., ‘requester’, ‘stats’, ‘tags’) |
freshservice_reply_to_ticket
Reply to a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
bcc_emails | string[] | No | — | BCC email addresses |
body | string | Yes | — | HTML content of the reply |
cc_emails | string[] | No | — | CC email addresses |
from_email | string | No | — | Email address from which the reply is sent |
freshservice_search_assets
DEPRECATED — Search assets by query. Use list_assets with the query parameter instead. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | Yes | — | Search query to filter assets (e.g., “name:‘Dell Laptop’“) |
freshservice_update_asset
Update an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_display_id | integer | Yes | — | Display ID of the asset |
agent_id | integer | No | — | Agent ID |
asset_tag | string | No | — | Asset tag |
asset_type_id | integer | No | — | Asset type ID |
department_id | integer | No | — | Department ID |
description | string | No | — | The description value |
group_id | integer | No | — | Group ID |
impact | string | No | — | Impact level |
location_id | integer | No | — | Location ID |
name | string | No | — | Name of the asset |
usage_type | string | No | — | Usage type |
user_id | integer | No | — | User ID |
freshservice_update_ticket
Update a ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_id | integer | Yes | — | ID of the ticket |
category | string | No | — | Ticket category |
description | string | No | — | HTML content of the ticket |
due_by | string | No | — | Due date |
fr_due_by | string | No | — | First response due date |
group_id | integer | No | — | Group ID |
impact | integer | No | — | Impact level |
item_category | string | No | — | Item category |
priority | integer | No | — | Priority: 1=Low, 2=Medium, 3=High, 4=Urgent |
responder_id | integer | No | — | Agent ID |
source | integer | No | — | Source channel |
status | integer | No | — | Status: 2=Open, 3=Pending, 4=Resolved, 5=Closed |
sub_category | string | No | — | Sub-category |
subject | string | No | — | Ticket subject |
tags | string[] | No | — | The tags value |
type | string | No | — | Ticket type |
urgency | integer | No | — | Urgency level |

