---
title: Freshservice API Integration on Truto
slug: freshservice
category: Incident Management
canonical: "https://truto.one/integrations/detail/freshservice/"
---

# Freshservice API Integration on Truto



**Category:** Incident Management  
**Status:** Generally available

## Unified APIs

### Unified User Directory API

- **Groups** — Groups are a collection of users in the source application. In some applications, they might also be called Teams.
- **Roles** — The Role object represents a role of a User.
- **Users** — The User object represents a User.
- **Workspaces** — Workspaces represent concepts like teams, workspaces, projects in apps that support them

### Unified Ticketing API

- **Attachments** — Attachments are the files associated with a ticket or a comment.

## MCP-ready AI tools

Truto exposes 394 tools for Freshservice that AI agents can call directly.

- **list_all_freshservice_agents** — List all agents in Freshservice. Returns details such as id, first_name, last_name, active, job_title, email, phone numbers, department_ids, roles, reporting_manager_id, location_id, scoreboard_level_id, last_login_at, last_active_at, and custom_fields.
- **get_single_freshservice_agent_by_id** — Get detailed information about a specific agent in Freshservice. Requires id. Returns agent fields including id, first_name, last_name, email, active, job_title, department_ids, roles, last_login_at, custom_fields, and more.
- **delete_a_freshservice_agent_by_id** — Delete an agent in Freshservice, identified by id. Permanently removes the agent and tickets they requested. No content is returned in the response.
- **create_a_freshservice_agent** — Create a new agent in Freshservice. Requires first_name and email. Returns id, first_name, last_name, email, job_title, department_ids, member_of, observer_of, roles, and other agent details in the response.
- **update_a_freshservice_agent_by_id** — Update an agent profile in Freshservice. Requires id. Returns fields such as id, first_name, last_name, occasional, active, email, job_title, department_ids, member_of, observer_of, roles, custom_fields, and others in the response.
- **freshservice_agents_deactivate** — Deactivate an agent in Freshservice. Requires id. Returns agent fields such as id, first_name, last_name, active status, email, job_title, department_ids, roles, last_login_at, and custom_fields.
- **freshservice_agents_reactivate** — Reactivate a deactivated agent in Freshservice. Requires id. Returns fields including first_name, last_name, email, job_title, department_ids, roles, and status indicators for the agent.
- **freshservice_agents_convert_to_requester** — Convert an agent to a requester in Freshservice. Requires id. Returns fields including id, first_name, last_name, job_title, primary_email, department_ids, active status, and more in the response.
- **list_all_freshservice_agent_roles** — List all agent-roles in Freshservice. Returns id, name, description, default, scopes, created_at, and updated_at fields for each role.
- **get_single_freshservice_agent_role_by_id** — Get details of a specific agent role in Freshservice using id. Returns id, name, description, default status, scopes, created_at, and updated_at fields in the response.
- **list_all_freshservice_tickets** — Get a list of tickets in Freshservice. Returns ticket fields including id, subject, status, priority, type, description, requester_id, requested_for_id, workspace_id, created_at, and updated_at.
- **get_single_freshservice_ticket_by_id** — Get information about a specific ticket in Freshservice. Requires id. Returns fields including id, subject, description, status, priority, requester_id, requested_for_id, created_at, updated_at, attachments, and workspace_id.
- **create_a_freshservice_ticket** — Create a new ticket in Freshservice.
- **update_a_freshservice_ticket_by_id** — Update a ticket by id in Freshservice. Returns updated ticket fields including id, status, priority, subject, description, requester_id, requested_for_id, source, tags, attachments, assets, and workspace_id.
- **delete_a_freshservice_ticket_by_id** — Delete a ticket by id in Freshservice. Deleted tickets can be restored and deleting a parent ticket deletes all child tickets. No content is returned in the response.
- **freshservice_tickets_filter** — Get list of tickets filtered by query in Freshservice. Requires query parameter with URL encoded filter string. Returns tickets array with fields like id, subject, status, priority, requester_id, due_by, created_at, and custom_fields.
- **freshservice_tickets_move_a_ticket** — Move a ticket in Freshservice to a different workspace and modify assigned group and agent. Requires id. Returns fields such as id, subject, description, group_id, responder_id, requester_id, status, tags, workspace_id, and custom_fields in the response.
- **freshservice_tickets_restore_a_ticket** — Restore a deleted ticket in Freshservice. Requires id. Returns HTTP 204 No Content if successful and does not return any fields in the response.
- **freshservice_tickets_create_child_ticket** — Create a child ticket in Freshservice for an existing ticket using id. Returns ticket fields such as cc_emails, priority, requester_id, source, status, subject, id, type, due_by, description, custom_fields, created_at, updated_at, tags, attachments, and workspace_id. Limitations: feature not available in Sprout plan, cannot associate to deleted/spam ticket, and cannot nest under another child ticket. Requires requester_id or one of email, phone, status, priority, or source.
- **list_all_freshservice_conversations** — List all conversations for a specific ticket in Freshservice. Requires id. Returns fields such as id, body, body_text, incoming, private, created_at, updated_at, user_id, and related email and attachment information for each conversation.
- **freshservice_conversations_create_reply** — Create a reply on a Freshservice conversation for ticket id. Returns id, user_id, from_email, cc_emails, bcc_emails, body, body_text, ticket_id, to_emails, attachments, created_at, and updated_at in the response. The 'body' field is required. Attachments' total size across the ticket cannot exceed 40 MB.
- **freshservice_conversations_create_note** — Create a note in Freshservice for a specific ticket. Requires ticket_id and body. Returns id, incoming, private, user_id, body, body_text, ticket_id, to_emails, attachments, created_at, and updated_at fields in the response.
- **update_a_freshservice_conversation_by_id** — Update a conversation in Freshservice using id. Only public and private notes can be edited. Returns id, incoming, private, user_id, body, body_text, ticket_id, to_emails, attachments, created_at, and updated_at fields in the response.
- **delete_a_freshservice_conversation_by_id** — Delete conversation in Freshservice using id. Returns 204 status with no content if successful.
- **list_all_freshservice_requesters** — List all requesters in Freshservice. Returns id, is_agent, first_name, last_name, job_title, primary_email, secondary_emails, phone numbers, department_ids, custom_fields, and other requester details in the response.
- **get_single_freshservice_requester_by_id** — Get information about a specific requester in Freshservice. Requires id. Returns fields including id, first_name, last_name, primary_email, phone numbers, department_ids, address, custom_fields, active status, and other requester details in the response.
- **create_a_freshservice_requester** — Create a requester in Freshservice. Requires primary_email. Returns fields including id, first_name, last_name, job_title, primary_email, secondary_emails, phone numbers, department_ids, reporting_manager_id, address, time_zone, language, location_id, background_information, custom_fields, active, and has_logged_in. Cannot create if client status is Deactivated.
- **update_a_freshservice_requester_by_id** — Update a requester profile in Freshservice. Requires id. Returns fields such as id, belongs_to_workspace_ids, first_name, last_name, job_title, primary_email, department_ids, can_see_all_tickets_from_associated_departments, language, location_id, custom_fields, active, and more in the response. Note: can_see_all_tickets_from_associated_departments will automatically be set to false unless explicitly set to true.
- **delete_a_freshservice_requester_by_id** — Delete a requester in Freshservice by id along with the tickets they requested. Returns no content in the response.
- **freshservice_requesters_filter_requester** — List requesters in Freshservice using the query parameter. Returns fields such as id, first_name, last_name, name, job_title, email, department_ids, custom_fields, created_at, and updated_at. Results sorted by created_at descending. Query must be URL encoded and within 512 characters. See documentation for supported query syntax and field limitations.
- **freshservice_requesters_deactivate_requester** — Deactivate a requester in Freshservice. Requires id. No content is returned in the response.
- **freshservice_requesters_reactivate_requester** — Reactivate a deactivated requester in Freshservice. Requires id. Returns requester fields such as id, belongs_to_workspace_ids, primary_email, department_ids, contact details, active status, and custom_fields. Cannot reactivate if the client workspace is inactive.
- **freshservice_requesters_convert_to_agent** — Convert a requester to an occasional agent in Freshservice. Requires id. Returns agent fields including id, name, email, occasional, job title, contact info, reporting_manager_id, address, language, roles, activity timestamps, and workspace associations.
- **freshservice_requesters_merge** — Merge secondary requesters into a primary requester in Freshservice. Requires id and secondary_requesters. Returns id, is_agent, first_name, last_name, job_title, primary_email, secondary_emails, work_phone_number, mobile_phone_number, department_ids, can_see_all_tickets_from_associated_departments, reporting_manager_id, address, time_zone, time_format, language, location_id, background_information, custom_fields, active, and has_logged_in fields in the response. In Freshservice for MSPs, contacts can only be merged if they belong to the same client (have the same belongs_to_workspace_ids).
- **list_all_freshservice_departments** — List all departments in Freshservice Freshservice. Returns id, name, description, head_user_id, prime_user_id, domains, custom_fields, workspace_id, created_at, and updated_at for each department. If workspace_id is not specified, defaults to 2.
- **get_single_freshservice_department_by_id** — Get information about a specific department in Freshservice. Requires id. Returns fields such as id, name, description, head_user_id, prime_user_id, domains, workspace_id, and custom_fields in the response.
- **create_a_freshservice_department** — Create a new department in Freshservice. You cannot create departments for workspace_id=1 (Global). Returns id, name, description, head_user_id, prime_user_id, domains, custom_fields, created_at, and updated_at in the response.
- **update_a_freshservice_department_by_id** — Update a department in Freshservice. Requires id. Returns the updated department with fields: id, name, description, head_user_id, prime_user_id, domains, workspace_id, and custom_fields in the response.
- **delete_a_freshservice_department_by_id** — Delete a department in Freshservice using id. Returns HTTP 204 No Content if successful.
- **freshservice_departments_filter** — List departments in Freshservice. Returns department fields such as name. Requires query parameter for filtering.
- **create_a_freshservice_agent_group** — Create an agent group in Freshservice. Requires name. Returns id, name, description, business_hours_id, escalate_to, unassigned_for, restricted, workspace_id, members, observers, leaders, members_pending_approval, leaders_pending_approval, observers_pending_approval, auto_ticket_assign, created_at, and updated_at in the response.
- **get_single_freshservice_agent_group_by_id** — Get agent group in Freshservice by id. Returns fields including id, name, description, escalate_to, unassigned_for, business_hours_id, created_at, updated_at, auto_ticket_assign, restricted, approval_required, workspace_id, members, observers, leaders, and pending approval lists.
- **list_all_freshservice_agent_groups** — List all agent groups in Freshservice. Returns id, name, description, business_hours_id, escalate_to, unassigned_for, workspace_id, members, observers, restricted, approval_required, leaders, members_pending_approval, leaders_pending_approval, observers_pending_approval, auto_ticket_assign, created_at, and updated_at for each group. Requires workspace_id for workspace-level groups.
- **update_a_freshservice_agent_group_by_id** — Update an agent group in Freshservice using id. Returns fields such as id, name, description, business_hours_id, escalate_to, unassigned_for, workspace_id, members, observers, restricted, leaders, auto_ticket_assign, created_at, updated_at, and lists of pending approvals. To remove all agents from a group, set members to an empty array. Appending pending users from *_pending_approval fields to their respective members, observers, or leaders fields retains pending approval requests; otherwise, pending requests will be withdrawn.
- **delete_a_freshservice_agent_group_by_id** — Delete an agent-group in Freshservice. Requires id. Agents remain intact; the group cannot be restored. Response indicates success with HTTP 204 status and no content.
- **list_all_freshservice_workspaces** — List all workspaces in Freshservice. Returns workspaces and clients with fields including id, name, description, state, primary, restricted, template_name, type, created_at, updated_at, and optional metadata with primary_contact, email_domains, and custom_fields.
- **get_single_freshservice_workspace_by_id** — Get information about a specific workspace in Freshservice using id. Returns fields such as id, name, description, primary, restricted, state, template_name, type, created_at, updated_at, and, if available, metadata including primary_contact, email_domains, and custom_fields.
- **create_a_freshservice_workspace** — Create a client workspace in Freshservice. Cannot create with id 1, 2, or 3 (system generated). Returns id, created_at, description, name, primary, restricted, state, template_name, updated_at, type, and metadata fields in the response.
- **update_a_freshservice_workspace_by_id** — Update a specific workspace in Freshservice. id is required. Cannot update workspaces with id = 1 or 2. Returns id, created_at, description, name, primary, restricted, state, template_name, updated_at, type, and metadata including primary_contact, email_domains, and custom_fields.
- **delete_a_freshservice_workspace_by_id** — Delete a specific workspace (client) in Freshservice. Cannot delete clients with id = 1, 2, or 3 as these are reserved. Returns HTTP 204 No Content on success.
- **list_all_freshservice_ticket_fields** — List all ticket fields in Freshservice. Returns each field's id, workspace_id, created_at, updated_at, name, label, description, field_type, required, required_for_closure, default_field, choices, nested_fields, required_for_agents, required_for_customers, label_for_customers, customers_can_edit, displayed_to_customers, portal_cc, portal_cc_to, date_only, and related properties.
- **get_single_freshservice_ticket_activity_by_id** — Get ticket activity for a specific ticket in Freshservice. Requires id. Returns actor (id, name), content, sub_contents, and created_at for each activity in the response.
- **create_a_freshservice_time_entry** — Create a time entry for a ticket in Freshservice. Requires ticket_id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields in the response. Note: If timer_running is not specified, time_spent is mandatory. time_spent can only be set if timer_running is false or not set.
- **get_single_freshservice_time_entry_by_id** — Get a specific time entry in Freshservice. Requires ticket_id and id. Returns fields including id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **list_all_freshservice_time_entries** — List all time-entries for a ticket in Freshservice. Requires ticket_id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, custom_fields for each time-entry.
- **update_a_freshservice_time_entry_by_id** — Update a time entry in Freshservice. Requires ticket_id and id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields in the response. For a running timer, time_spent cannot be updated without stopping it.
- **delete_a_freshservice_time_entry_by_id** — Delete a specific time-entry in Freshservice. Requires ticket_id and id. Deleted time entries cannot be restored. Returns HTTP 200 OK on successful deletion.
- **create_a_freshservice_ticket_source** — Create a ticket-source in Freshservice. Requires name. Returns id, created_at, updated_at, choice_id, value, position, visible, and default for the created ticket-source.
- **create_a_freshservice_service_request** — Create a service request in Freshservice for a specific item using id. Returns id, subject, status, approval_status, approval_status_name, custom_fields, requester_id, created_at, updated_at, attachments, and other ticket details in the response.
- **create_a_freshservice_child_service_request** — Create a child service request for a specific service catalog item in Freshservice using id. Returns fields including id, status, priority, custom_fields, approval_status, approval_status_name, requester_id, workspace_id, and more. Child requests cannot be nested or associated to deleted/spam tickets.
- **list_all_freshservice_service_request_requested_items** — List requested items for a specific service request in Freshservice using id. Returns fields such as id, created_at, updated_at, quantity, stage, loaned, cost_per_request, remarks, delivery_time, is_parent, service_item_id, and attachments.
- **update_a_freshservice_service_request_requested_item_by_id** — Update requested items of a service request in Freshservice. Requires ticket_id and id. Returns fields such as id, item_id, from_date, to_date, quantity, service_request_id, stage, fulfilled, cost, custom_fields, and item with related data.
- **list_all_freshservice_service_request_approvals** — List all service request approvals for a ticket in Freshservice. Requires ticket_id. Returns approval id, created_at, updated_at, approver_id, approver_name, approval_type, user_id, level, user_name, approval_status, delegatee, approval_group, and latest_remark fields in the response.
- **get_single_freshservice_service_request_approval_by_id** — Get a specific service-request-approval in Freshservice by ticket_id and id. Returns fields such as created_at, approver_id, approver_name, approval_type, approval_status, delegatee, approval_group, email_content, and latest_remark in the response.
- **freshservice_service_request_approvals_request_approval_for_service_request** — Create a service request approval in Freshservice for the given ticket_id. Returns id, created_at, updated_at, approver_id, approval_status (id, name), approval_group (id, name, rule), and delegatee (id, name) for each approval.
- **freshservice_service_request_approvals_send_reminder_for_approval** — Send a reminder for a specific service-request-approval in Freshservice. Requires ticket_id and id. No content is returned in the response.
- **freshservice_service_request_approvals_cancel_an_approval** — Cancel an existing approval on a service request in Freshservice using ticket_id and id. Returns the approval's id, created_at, updated_at, approver_id, approver_name, approval_type, approval_status, delegatee, approval_group, and latest_remark.
- **list_all_freshservice_ticket_approval_groups** — List all ticket-approval-groups for a specific ticket in Freshservice. Requires ticket_id. Returns approval_groups with id, name, rule, status (id, name), and level for each group.
- **create_a_freshservice_ticket_approval_group** — Create an approval group for a service request in Freshservice using ticket_id. Returns id, name, rule, status, created_at, updated_at, level, and approvals with relevant approval details.
- **update_a_freshservice_ticket_approval_group_by_id** — Update approval group in Freshservice for a specific ticket using ticket_id and id. Returns fields such as id, name, rule, status, created_at, updated_at, level, and approvals with detailed approver and delegatee information.
- **freshservice_ticket_approval_groups_cancel_approval_groups_in_service_request** — Cancel a specific ticket-approval-group in Freshservice for the given ticket_id and id. Returns id, name, rule, status, created_at, updated_at, level, and a list of approvals with their details in the response.
- **list_all_freshservice_tasks** — List tasks for a specific ticket in Freshservice. Requires id. Returns tasks with fields: id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, workspace_id.
- **get_single_freshservice_task_by_id** — Get a specific task in Freshservice by ticket_id and id. Returns id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id fields in the response.
- **create_a_freshservice_task** — Create a new task for a specific ticket in Freshservice. Requires id. Returns task fields including id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, deleted, and workspace_id in the response.
- **update_a_freshservice_task_by_id** — Update a task in Freshservice. Requires ticket_id and id. Returns task fields including id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **delete_a_freshservice_task_by_id** — Delete a task from a ticket in Freshservice. Requires ticket_id and id. Deleted tasks are permanently lost and cannot be retrieved. Returns HTTP 204 status on success.
- **list_all_freshservice_problems** — List all problems in Freshservice. Returns fields such as id, agent_id, requester_id, description, subject, priority, impact, status, category, sub_category, item_category, assets, created_at, updated_at, workspace_id.
- **get_single_freshservice_problem_by_id** — Get details about a specific problem in Freshservice using id. Returns fields such as id, agent_id, requester_id, description, subject, priority, impact, status, known_error, category, created_at, updated_at, custom_fields, and analysis_fields.
- **create_a_freshservice_problem** — Create a new problem in Freshservice. Returns id, subject, description, due_by, priority, status, impact, category, sub_category, item_category, agent_id, group_id, department_id, workspace_id, custom_fields, and analysis_fields.
- **update_a_freshservice_problem_by_id** — Update a specific problem in Freshservice. Requires id. The response returns fields such as id, subject, description, status, priority, impact, due_by, category, sub_category, item_category, agent_id, group_id, department_id, custom_fields, analysis_fields, created_at, updated_at, and workspace_id. The workspace_id attribute cannot be updated through this operation. Use the Move operation to update workspace_id.
- **delete_a_freshservice_problem_by_id** — Delete a specific problem in Freshservice using id. Returns a 200 OK on successful deletion.
- **freshservice_problems_move_a_problem** — Move a problem in Freshservice to a different workspace. Requires id. Returns fields such as agent_id, requester_id, description, subject, group_id, priority, impact, status, known_error, category, sub_category, item_category, created_at, updated_at, workspace_id, custom_fields, and analysis_fields in the response. Only applicable to accounts on Employee Support Mode.
- **freshservice_problems_restore_problem** — Restore a deleted problem in Freshservice. Requires id. Returns HTTP 204 status on successful restoration with no response content.
- **list_all_freshservice_problem_fields** — List all problem fields in Freshservice. Returns fields with details: id (field identifier), workspace_id, created_at, updated_at, name, label, description, field_type, required, required_for_closure, default_field, choices, and nested_fields.
- **create_a_freshservice_problem_time_entry** — Create a new time entry on a problem in Freshservice. Requires id. Returns fields such as id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, custom_fields.
- **get_single_freshservice_problem_time_entry_by_id** — Get a time entry on a Problem in Freshservice. Requires problem_id and id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields in the response.
- **list_all_freshservice_problem_time_entries** — List all time entries for a specific problem in Freshservice. Requires id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields for each entry.
- **update_a_freshservice_problem_time_entry_by_id** — Update a time entry for a specific problem in Freshservice. Requires problem_id and id. Returns fields such as id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, workspace_id, note, agent_id, and custom_fields in the response.
- **delete_a_freshservice_problem_time_entry_by_id** — Delete a specific time entry in Freshservice within a problem using problem_id and id. Returns HTTP 200 OK on successful deletion.
- **create_a_freshservice_problem_task** — Create a task on a problem in Freshservice using id. Returns id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id for the created task.
- **get_single_freshservice_problem_task_by_id** — Get details of a specific problem-task in Freshservice using problem_id and id. Returns fields such as id, agent_id, status, due_date, title, description, and timestamps in the response.
- **list_all_freshservice_problem_tasks** — List tasks for a specific problem in Freshservice. Requires id. Returns fields: id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, workspace_id.
- **update_a_freshservice_problem_task_by_id** — Update a task in Freshservice. Requires problem_id and id. Returns task details including id, status, due_date, title, description, notify_before, workspace_id, timestamps, and agent/group assignment fields.
- **delete_a_freshservice_problem_task_by_id** — Delete a task in Freshservice under the specified problem_id and id. Deleted tasks are permanently lost and cannot be retrieved. No content is returned in the response.
- **list_all_freshservice_changes** — List changes in Freshservice. Returns key fields such as id, subject, description, workspace_id, requester_id, priority, impact, status, risk, change_type, approval_status, planned_start_date, planned_end_date, created_at, updated_at, custom_fields, assets, impacted_services, maintenance_window, and blackout_window in the response. By default, only changes from the primary workspace and not deleted or spam will be included unless filters are set. See documentation for workspace_id, view, or query parameter requirements.
- **get_single_freshservice_change_by_id** — Get details of a specific change in Freshservice by id. Returns fields including id, subject, status, description, requester_id, custom_fields, planning_fields, assets, impacted_services, maintenance_window, and timestamps.
- **create_a_freshservice_change** — Create a new change in Freshservice. Returns fields including id, agent_id, description, description_text, workspace_id, requester_id, group_id, priority, impact, status, risk, change_type, approval_status, planned_start_date, planned_end_date, subject, department_id, category, sub_category, item_category, created_at, updated_at, custom_fields, planning_fields, assets, maintenance_window, and blackout_window in the response.
- **update_a_freshservice_change_by_id** — Update a Change in Freshservice by id. The response includes fields such as id, agent_id, description, description_text, workspace_id, requester_id, group_id, priority, impact, status, risk, change_type, approval_status, planned_start_date, planned_end_date, subject, department_id, category, sub_category, item_category, created_at, updated_at, custom_fields, planning_fields, and assets. The workspace_id attribute cannot be updated in this operation.
- **delete_a_freshservice_change_by_id** — Delete a specific change in Freshservice. Requires id. Returns 204 No Content if successful; deleted changes can be restored using the Restore Change API.
- **freshservice_changes_move_change** — Move a change to a different workspace in Freshservice. Requires id. Returns fields such as id, agent_id, workspace_id, requester_id, group_id, status, approval_status, planning and custom fields, and timestamps. Only applicable to accounts on Employee Support Mode.
- **list_all_freshservice_changes_approval_groups** — List all Approval Groups in a Change in Freshservice. Requires change_id. Returns approval group id, name, rule, status (id and name), and level for each group.
- **get_single_freshservice_changes_approval_group_by_id** — Get approval group details for a specific change approval in Freshservice. Requires change_id and id. Returns approval_group fields including id, name, and rule in the response.
- **create_a_freshservice_changes_approval_group** — Create an approval group for a Change in Freshservice. Requires change_id. Returns id, name, rule, status, created_at, updated_at, level, and approvals with their details in the response.
- **update_a_freshservice_changes_approval_group_by_id** — Update a specific approval group in Freshservice using change_id and id. Returns approval group details, including id, name, rule, status, created_at, updated_at, level, and approvals with approver and approval status info.
- **freshservice_changes_approval_groups_cancel_change_approval_group** — Cancel an approval group in Freshservice for a specific change. Requires change_id and id. Returns id, name, rule, status, created_at, updated_at, level, and approvals with details including approval_status and delegatee in the response.
- **update_a_freshservice_change_approval_chain_rule_by_id** — Update approval chain rule for a change in Freshservice. Requires id. Returns level, rule, status (with id and name), approval_groups array (each with id, name, rule, and status fields) in the response.
- **list_all_freshservice_change_approvals** — List all change approvals in Freshservice for the given change_id. Returns id, created_at, updated_at, approver_id, approver_name, approval_type, user_id, level, user_name, approval_status, delegatee, approval_group, latest_remark for each approval.
- **get_single_freshservice_change_approval_by_id** — Get a specific change approval in Freshservice with change_id and id. Returns id, created_at, updated_at, approver_id, approver_name, approval_type, user_id, level, user_name, approval_status, delegatee, latest_remark, and approval_group fields in the response.
- **freshservice_change_approvals_cancel_change_approval** — Cancel an approval for a change in Freshservice. Requires change_id and id. Returns approval details including id, approver info, approval_status, approval_group, delegatee, and latest_remark. Only 'cancelled' status is supported.
- **freshservice_change_approvals_send_cahnge_approval_reminder** — Send a reminder for a specific change approval in Freshservice. Requires change_id and id. Returns HTTP 200 No Content on success.
- **create_a_freshservice_change_note** — Create a note on a change request in Freshservice using id. Returns note fields id, created_at, updated_at, body, body_text, user_id, and notify_emails in the response.
- **get_single_freshservice_change_note_by_id** — Get a specific change note in Freshservice using change_id and id. Returns id, created_at, updated_at, body, body_text, user_id, and notify_emails fields in the response.
- **list_all_freshservice_change_notes** — List all notes for a specific change request in Freshservice using id. Returns id, created_at, updated_at, body, body_text, user_id, and notify_emails for each note.
- **update_a_freshservice_change_note_by_id** — Update a specific change note in Freshservice. Requires change_id and id. Returns fields such as id, created_at, updated_at, body, body_text, user_id, and notify_emails in the response.
- **delete_a_freshservice_change_note_by_id** — Delete a note in Freshservice for a specific change request. Requires change_id and id. Deleted notes are permanently lost and cannot be retrieved. No content is returned in the response.
- **create_a_freshservice_change_request_time_entry** — Create a time entry on a change request in Freshservice. Requires id. Returns time_entry fields including id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, custom_fields.
- **get_single_freshservice_change_request_time_entry_by_id** — Get a specific time entry for a change request in Freshservice. Requires change_id and id. Returns fields such as id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **list_all_freshservice_change_request_time_entry** — List all time entries for a specific change request in Freshservice. Requires id. Returns fields such as id, created_at, updated_at, start_time, billable, time_spent, executed_at, workspace_id, note, agent_id, and custom_fields for each time entry.
- **update_a_freshservice_change_request_time_entry_by_id** — Update a time entry in Freshservice using change_id and id. Returns id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **delete_a_freshservice_change_request_time_entry_by_id** — Delete a specific time entry from a change request in Freshservice. Requires change_id and id. No content is returned in the response.
- **create_a_freshservice_change_task** — Create a new change task in Freshservice for a specific change request using id. Returns task fields including id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **get_single_freshservice_change_task_by_id** — Get a task for a given change_id and id in Freshservice. Returns task fields including id, agent_id, status, due_date, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **list_all_freshservice_change_tasks** — List tasks for a specific change request in Freshservice. Requires id. Returns fields such as id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id in the response.
- **update_a_freshservice_change_task_by_id** — Update a task in Freshservice for a specific change_id and id. Returns id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id fields in the response.
- **delete_a_freshservice_change_task_by_id** — Delete a specific change-task in Freshservice. Requires change_id and id. Deleted tasks are permanently lost and cannot be retrieved. No content is returned in the response.
- **list_all_freshservice_releases** — List all releases in Freshservice. Returns fields such as id, agent_id, group_id, priority, status, subject, planned and work dates, category, workspace_id, assets, associated_assets, associated_changes, custom_fields, and planning_fields. If workspace_id is not specified, only releases from the primary workspace are included. If workspace_id is 0, releases from all workspaces are included with only global fields. Requires no parameters.
- **get_single_freshservice_release_by_id** — Get a specific release in Freshservice by id. Returns fields such as id, agent_id, group_id, priority, status, subject, planned_start_date, work_start_date, category, assets, associated_assets, associated_changes, custom_fields, and planning_fields.
- **create_a_freshservice_release** — Create a release in Freshservice. Returns fields including id, agent_id, description, description_text, workspace_id, group_id, department_id, subject, category, sub_category, item_category, assets, planned_start_date, planned_end_date, status, priority, release_type, work_start_date, work_end_date, created_at, updated_at, associated_change_ids, custom_fields, and planning_fields. Set Content-Type to multipart/form-data when uploading attachments.
- **update_a_freshservice_release_by_id** — Update an existing release in Freshservice. Requires id. Returns fields such as id, agent_id, group_id, priority, status, release_type, subject, description, planned_start_date, planned_end_date, work_start_date, work_end_date, department_id, category, sub_category, item_category, created_at, updated_at, workspace_id, associated_assets, associated_changes, custom_fields, and planning_fields. Note: workspace_id cannot be updated through this operation.
- **delete_a_freshservice_release_by_id** — Delete a release in Freshservice with the specified id. Returns HTTP 200 OK on successful deletion.
- **freshservice_releases_filter_releases** — List releases in Freshservice filtered by filter_name. Returns fields such as id, subject, status, priority, category, created_at, updated_at, requester_id, and status_name for each release.
- **freshservice_releases_restore_release** — Restore a deleted release in Freshservice using id. No content is returned in the response.
- **list_all_freshservice_release_fields** — List all release-fields in Freshservice. Returns fields such as id, workspace_id, created_at, updated_at, name, label, description, field_type, required, required_for_closure, default_field, choices, and nested_fields.
- **create_a_freshservice_release_note** — Create a note on a release in Freshservice. Requires id. Returns id, created_at, updated_at, body, body_text, user_id, and notify_emails fields for the newly created note.
- **get_single_freshservice_release_note_by_id** — Get a specific release note in Freshservice. Requires release_id and id. Returns id, created_at, updated_at, body, body_text, user_id, and notify_emails of the note in the response.
- **list_all_freshservice_release_notes** — List all notes for a specific release in Freshservice. Requires id. Returns fields: id, created_at, updated_at, body, body_text, user_id, notify_emails for each note.
- **update_a_freshservice_release_note_by_id** — Update a note in Freshservice for a release. Requires release_id and id. Returns id, created_at, updated_at, body (HTML), body_text (plain text), user_id of note, and notify_emails fields in the response.
- **delete_a_freshservice_release_note_by_id** — Delete a release note in Freshservice. Requires release_id and id. Deleted notes are permanently lost and cannot be retrieved. The response returns an empty body on success.
- **create_a_freshservice_release_time_entry** — Create a time entry in Freshservice for a specific release. Requires id. Returns time entry fields such as id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **get_single_freshservice_release_time_entry_by_id** — Get a specific time entry in Freshservice for a release using release_id and id. Returns fields such as created_at, updated_at, start_time, time_spent, agent_id, note, and billable status.
- **list_all_freshservice_release_time_entry** — List all time entries for a specific release in Freshservice. Requires id. Returns fields such as id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **update_a_freshservice_release_time_entry_by_id** — Update a specific time entry in Freshservice for a release request using release_id and id. Response returns key fields including id, created_at, updated_at, start_time, timer_running, billable, time_spent, executed_at, task_id, workspace_id, note, agent_id, and custom_fields.
- **delete_a_freshservice_release_time_entry_by_id** — Delete a time entry in Freshservice for a specific release. Requires release_id and id. Returns HTTP 200 OK on success.
- **create_a_freshservice_release_task** — Create a task in a specific release in Freshservice. Requires id. Returns fields including id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **get_single_freshservice_release_task_by_id** — Get a task in Freshservice using release_id and id. Returns fields: id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **list_all_freshservice_release_tasks** — List tasks for a specific release in Freshservice using id. Returns tasks with fields such as id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id.
- **update_a_freshservice_release_task_by_id** — Update a release-task in Freshservice using release_id and id. Returns id, agent_id, status, due_date, notify_before, title, description, created_at, updated_at, closed_at, group_id, and workspace_id in the response.
- **delete_a_freshservice_release_task_by_id** — Delete a task in Freshservice using release_id and id. Deleted tasks are permanently lost and cannot be retrieved. Returns HTTP 204 status on success.
- **create_a_freshservice_cab** — Create a CAB in Freshservice. Requires name. Up to 100 user IDs can be provided in add_members. Returns id, name, description, members, created_at, and updated_at fields in the response.
- **list_all_freshservice_cabs** — List all CABs in Freshservice. Returns cabs with fields: id (CAB identifier), name (CAB name), description (CAB description), created_at, and updated_at.
- **get_single_freshservice_cab_by_id** — Get details about a specific CAB in Freshservice using id. Returns fields such as id, name, description, created_at, updated_at, and members in the response.
- **update_a_freshservice_cab_by_id** — Update a CAB in Freshservice using id. Returns id, name, description, members, created_at, and updated_at fields in the response. Maximum of 100 user IDs can be passed to add_members or remove_members.
- **delete_a_freshservice_cab_by_id** — Delete a CAB in Freshservice. Requires id. Deleting a CAB disbands it and deletes its details, but does not remove members/users. Deleted CABs cannot be restored. No content is returned in the response.
- **list_all_freshservice_workspace_fields** — List all client fields in Freshservice for MSPs. Returns fields with id, created_at, updated_at, name, label, placeholder, type, required, default, and choices.
- **list_all_freshservice_approvals** — List all approvals in Freshservice. Requires parent, and one of approver_id, status, parent_id, or delegatee_id. Returns approvals with id, parent, parent_id, created_at, updated_at, approver_id, approver_name, approval_type, level, user_id, user_name, approval_status, approval_group, delegatee, and latest_remark fields.
- **get_single_freshservice_user_assignment_history_by_id** — Get assignment history for a specific user in Freshservice. Requires id. Returns asset_name, managed_by_name, assigned_on, assigned_by_name, unassigned_on, and related fields.
- **list_all_freshservice_requester_fields** — List all requester fields in Freshservice. Returns fields such as id, name, label, position, user_field_group_id, type, editable_in_signup, requesters_can_edit, label_for_requesters, required_for_requesters, displayed_for_requesters, required_for_agents, choices, created_at, and updated_at in the response.
- **list_all_freshservice_agent_fields** — List all agent fields in Freshservice. Returns name, user_field_group_id, label_for_admins, editable_by_admins, mandatory_for_admins, label_for_agents, visible_to_agents, editable_by_agents, mandatory_for_agents, type, and default_field for each field.
- **list_all_freshservice_requester_groups** — List all requester groups in Freshservice. Optionally specify workspace_id to return contact groups for a specific client. Returns id, name, description, type, and workspace_id fields in the response.
- **get_single_freshservice_requester_group_by_id** — Get a specific requester group in Freshservice. Requires id. Returns id, name, description, type, and workspace_id fields for the requester group.
- **create_a_freshservice_requester_group** — Create a requester group in Freshservice. Only groups of type 'manual' can be created. Returns id, name, description, type, and workspace_id of the created group in the response.
- **update_a_freshservice_requester_group_by_id** — Update a specific requester group in Freshservice. Only groups of type 'manual' can be updated. Requires id. Returns id, name, description, type, and workspace_id in the response.
- **delete_a_freshservice_requester_group_by_id** — Delete a requester group in Freshservice. Requires id. Deleted requester groups cannot be restored; members are not deleted. Returns HTTP 204 No Content on success.
- **list_all_freshservice_requester_group_members** — List requester group members in Freshservice. Requires id. Returns id, first_name, last_name, email, and belongs_to_workspace_ids for each member.
- **create_a_freshservice_requester_group_member** — Add a requester to a specific manual requester group in Freshservice. Requires id and requester_id. Only one requester can be added at a time. Limits: See workspace_id restrictions in documentation. Returns HTTP status 200 on success.
- **delete_a_freshservice_requester_group_member_by_id** — Delete a requester from a manual requester group in Freshservice. Requires id and requester_id. Only manual groups are supported. Only one requester can be removed at a time. Returns a 204 No Content response.
- **create_a_freshservice_location** — Create a location in Freshservice. Requires name and workspace_id. Cannot create location for workspace_id=1 (Global). Returns id, name, address, workspace_id, created_at, updated_at, and other relevant fields in the response.
- **get_single_freshservice_location_by_id** — Get location details in Freshservice by id. Returns address, contact_name, created_at, email, id, workspace_id, name, primary, phone, and updated_at fields in the response.
- **list_all_freshservice_locations** — List all locations in Freshservice. Returns id, name, workspace_id, contact_name, address, email, phone, primary, created_at, updated_at fields for each location. By default, workspace_id=2 is used if not specified.
- **update_a_freshservice_location_by_id** — Update a location in Freshservice. Requires id. Returns id, name, parent_location_id, primary_contact_id, address, workspace_id, created_at, and updated_at fields in the response.
- **delete_a_freshservice_location_by_id** — Delete a specific location in Freshservice. Requires id. Returns no content in the response upon successful deletion.
- **freshservice_locations_filter** — List locations in Freshservice. Returns id, name, address, workspace_id, parent_location_id, contact_name, email, phone, and timestamps. If workspace_id is not provided, defaults to workspace_id=2.
- **create_a_freshservice_product** — Create a product in Freshservice. Requires name and asset_type_id. Returns id, name, asset_type_id, manufacturer, status, mode_of_procurement, depreciation_type_id, description, description_text, created_at, and updated_at in the response.
- **get_single_freshservice_product_by_id** — Get information about a specific product in Freshservice using id. Returns id, name, asset_type_id, manufacturer, status, mode_of_procurement, depreciation_type_id, description, description_text, created_at, and updated_at fields.
- **list_all_freshservice_products** — List all products in Freshservice. Returns fields for each product such as id, name, asset_type_id, manufacturer, status, mode_of_procurement, depreciation_type_id, description, description_text, created_at, and updated_at.
- **update_a_freshservice_product_by_id** — Update a product in Freshservice using id. Returns fields: id, name, asset_type_id, manufacturer, status, mode_of_procurement, depreciation_type_id, description, description_text, created_at, and updated_at.
- **delete_a_freshservice_product_by_id** — Delete a product in Freshservice. Requires id. No content is returned in the response.
- **create_a_freshservice_vendor** — Create a vendor in Freshservice. Requires name. Returns id, name, description, primary_contact_id, address (line1, city, state, country, zipcode), created_at, and updated_at in the response.
- **list_all_freshservice_vendors** — List all vendors in Freshservice. Returns key fields including id, name, description, primary_contact_id, address details, created_at, and updated_at for each vendor.
- **get_single_freshservice_vendor_by_id** — Get vendor information in Freshservice. Requires id. Returns id, name, description, primary_contact_id, address (line1, city, state, country, zipcode), created_at, and updated_at fields in the response.
- **update_a_freshservice_vendor_by_id** — Update a vendor in Freshservice using id. Returns id, name, description, primary_contact_id, address details (line1, city, state, country, zipcode), created_at, and updated_at in the response.
- **delete_a_freshservice_vendor_by_id** — Delete a vendor in Freshservice. Requires id. Returns no content in the response.
- **get_single_freshservice_alert_by_id** — Get details of an alert in Freshservice using id. Returns fields such as acknowledged_at, description, occurrence_time, severity, state, subject, tags, updated_at, and additional_info.
- **list_all_freshservice_alerts** — List bulk alerts in Freshservice using filters in 'query'. Returns fields such as id, workspace_id, severity, state, occurrence_time, updated_at, resource, tags, incident_id, integration_id, and key alert details.
- **freshservice_alerts_acknowledge** — Acknowledge an alert in Freshservice. Requires id. Returns fields including acknowledged_at (timestamp of acknowledgement), acknowledged_by_id (user id), state, severity, subject, and additional_info with metric and resource details.
- **freshservice_alerts_resolve** — Resolve an alert in Freshservice. Requires id. Returns fields such as id, state, severity, description, acknowledged_at, subject, updated_at, and additional_info describing the resolved alert.
- **freshservice_alerts_supress** — Suppress an alert in Freshservice. Requires id. Returns a 204 No Content response with no body upon successful suppression.
- **freshservice_alerts_unsupress** — Unsuppress an alert in Freshservice. Requires id. Returns no content on success.
- **delete_a_freshservice_alert_by_id** — Delete an alert in Freshservice. Requires id. Permanently removes the alert. No content is returned in the response.
- **create_a_freshservice_alert_note** — Create an alert note in Freshservice for a specific alert using id. Returns alert_note with fields: alert_id, id, description, user_id, created_at, updated_at, workspace_id.
- **get_single_freshservice_alert_note_by_id** — Get an alert note in Freshservice using alert_id and id. Returns created_at, user_id, description, id, updated_at, and workspace_id in the response.
- **list_all_freshservice_alert_notes** — List alert notes for a specific alert in Freshservice. Requires id. Returns created_at, user_id, description, id, updated_at, and workspace_id fields for each note.
- **update_a_freshservice_alert_note_by_id** — Update an alert note in Freshservice. Requires alert_id and id. Returns created_at, user_id, description, id, updated_at, and workspace_id fields in the response.
- **delete_a_freshservice_alert_note_by_id** — Delete an alert note in Freshservice. Requires id and note_id. Returns HTTP 204 status on successful deletion.
- **create_a_freshservice_asset** — Create an asset in Freshservice. Returns id, display_id, name, description, asset_type_id, impact, author_type, usage_type, asset_tag, user_id, department_id, location_id, agent_id, group_id, assigned_on, created_at, updated_at, type_fields, and workspace_id in the response.
- **get_single_freshservice_asset_by_id** — Get details about a specific asset in Freshservice using id. Returns fields such as id, display_id, name, description, asset_type_id, impact, usage_type, asset_tag, group_id, assigned_on, created_at, updated_at, workspace_id, created_by_source, last_updated_by_source, created_by_user, last_updated_by_user, and sources.
- **list_all_freshservice_assets** — List assets in Freshservice. Returns fields such as id, display_id, name, description, asset_type_id, impact, author_type, usage_type, asset_tag, user_id, location_id, department_id, agent_id, assigned_on, created_at, updated_at, workspace_id, created_by_source, last_updated_by_source, created_by_user, last_updated_by_user, and sources for each asset.
- **freshservice_assets_search** — Search assets in Freshservice by query string in search. Returns fields such as id, name, description, asset_tag, created_at, updated_at, asset_type_id, and related assignment/source info for each asset in the response. Search results are sorted by created_at in descending order by default. Search query must be URL encoded and enclosed in double quotes.
- **freshservice_assets_filter** — List assets in Freshservice using asset attribute filters. Requires filter parameter. Returns fields such as id, name, asset_type_id, asset_state, asset_tag, workspace_id, department_id, location_id, user_id, agent_id, serial_number, uuid, item_id, ip_addresses, mac_addresses, imei_number, device42_id, created_at, and updated_at. Filtered results cannot be sorted. Query must be URL encoded, enclosed in double quotes, and up to 512 characters. Maximum 40 pages returned; each page has 30 assets. Use workspace_id filter for assets from other workspaces. Updated assets take a few minutes to be indexed.
- **update_a_freshservice_asset_by_id** — Update an asset in Freshservice using id. Workspace_id cannot be updated via this operation. Returns fields such as id, display_id, name, description, asset_type_id, impact, usage_type, asset_tag, assigned_on, created_at, updated_at, type_fields, and more.
- **delete_a_freshservice_asset_by_id** — Delete an asset in Freshservice. Requires id. Returns HTTP 204 with no content if successful.
- **freshservice_assets_restore** — Restore a deleted asset in Freshservice. Requires id. Returns a 204 No Content response indicating successful restoration.
- **freshservice_assets_delete_permanently** — Delete an asset permanently in Freshservice. Requires id. This operation cannot be undone and no content is returned in the response.
- **freshservice_assets_move** — Move an asset in Freshservice to a different workspace using id. Returns fields including id, display_id, name, workspace_id, agent_id, group_id, usage_type, and updated_at. Endpoint applicable only for Employee Support Mode.
- **list_all_freshservice_asset_components** — List all asset components in Freshservice by display_id. Returns id, component_type, component_data, created_at, and updated_at fields for each component.
- **create_a_freshservice_asset_component** — Create a component for an asset in Freshservice. Requires id. Returns id, created_at, updated_at, component_type, and component_data fields in the response.
- **update_a_freshservice_asset_component_by_id** — Update a component for an asset in Freshservice. Requires display_id and id. Returns component fields such as id, created_at, updated_at, component_type, and component_data providing detailed component attributes.
- **list_all_freshservice_asset_requests** — List all requests associated with an asset in Freshservice. Requires id. Returns id, request_type, request_id, request_details, request_status, created_at, and updated_at for each request.
- **list_all_freshservice_asset_contracts** — List associated contracts for a specific asset in Freshservice. Requires display_id. Returns id, contract_id, contract_type, contract_name, and contract_status for each contract.
- **list_all_freshservice_asset_relationships** — List all relationships for an asset in Freshservice. Requires id. Returns fields: id, relationship_type_id, primary_id, primary_type, secondary_id, secondary_type, created_at, and updated_at for each relationship.
- **create_a_freshservice_relationship** — Create relationships in bulk in Freshservice. Returns job_id and href to track background job status. Requires relationships array with relationship_type_id, primary_id, primary_type, secondary_id, and secondary_type.
- **get_single_freshservice_relationship_by_id** — Get information about a specific relationship in Freshservice using id. Returns relationship_type_id, primary_id, primary_type, secondary_id, secondary_type, created_at, and updated_at in the response.
- **list_all_freshservice_relationships** — List all relationships in the Freshservice account. Returns id, relationship_type_id, primary_id, primary_type, secondary_id, secondary_type, created_at, and updated_at fields for each relationship.
- **delete_a_freshservice_relationship_by_id** — Delete relationships in bulk in Freshservice. Requires query parameter ids. Returns 204 No Content on success.
- **list_all_freshservice_relationship_types** — List all relationship-types in Freshservice. Returns id, is_default, description, created_at, updated_at, downstream_relation, upstream_relation, upstream_impact, and downstream_impact fields for each relationship type.
- **create_a_freshservice_purchase_order** — Create a new purchase order in Freshservice. Returns fields such as id, vendor_id, name, po_number, vendor_details, expected_delivery_date, created_at, status, shipping_address, purchase_items, and workspace_id in the response.
- **list_all_freshservice_purchase_orders** — List all purchase orders in Freshservice. If query.workspace_id is not specified, only purchase orders from the primary workspace are included. The response returns fields such as id, vendor_id, name, po_number, vendor_details, expected_delivery_date, created_at, updated_at, created_by, status, shipping_address, billing_same_as_shipping, billing_address, currency_code, department_id, discount_percentage, tax_percentage, shipping_cost, and workspace_id.
- **freshservice_purchase_orders_move** — Move a purchase order to a different workspace in Freshservice. Requires id. Returns fields such as id, name, po_number, vendor_id, status, purchase_items, shipping_cost, total_cost, workspace_id, and currency in the response. Only applicable to accounts on Employee Support Mode.
- **get_single_freshservice_purchase_order_by_id** — Get a specific purchase order in Freshservice using id. Returns fields such as id, vendor_id, name, po_number, delivery dates, status, addresses, currency details, purchase_items, and custom_fields.
- **update_a_freshservice_purchase_order_by_id** — Update a purchase order in Freshservice by id. Returns key fields: vendor_id, name, po_number, vendor_details, expected_delivery_date, billing and shipping details, custom_fields, purchase_items, and currency. Note: workspace_id cannot be updated using this operation.
- **delete_a_freshservice_purchase_order_by_id** — Delete a purchase-order in Freshservice. Requires id. Returns HTTP 204 No Content to confirm successful deletion.
- **create_a_freshservice_asset_type** — Create an asset type in Freshservice using name. Returns id, name, parent_asset_type_id, description, visible, created_at, and updated_at fields in the response.
- **get_single_freshservice_asset_type_by_id** — Get information about a specific asset type in Freshservice. Requires id. Returns id, name, parent_asset_type_id, description, visible, created_at, and updated_at fields in the response.
- **list_all_freshservice_asset_types** — List all asset types in Freshservice. Returns id, name, parent_asset_type_id, description, visible, created_at, and updated_at for each asset type.
- **update_a_freshservice_asset_type_by_id** — Update an asset type in Freshservice using id. Returns id, name, parent_asset_type_id, description, visible, created_at, and updated_at fields in the response.
- **delete_a_freshservice_asset_type_by_id** — Delete a specific asset type in Freshservice. Requires id. The response returns status 204 No Content to confirm successful deletion.
- **freshservice_asset_types_fields** — List all fields for a specific asset type in Freshservice. Requires id. Returns field_header and fields array with each field's id, name, label, type, data_type, required, is_unique, default_field, created_at, and updated_at.
- **create_a_freshservice_software** — Create a new software in Freshservice. Returns fields such as id, name, description, application_type, status, user_count, installation_count, category, notes, managed_by_id, source, created_at, updated_at, workspace_id, and publisher_id.
- **update_a_freshservice_software_by_id** — Update a software in Freshservice using id. Returns fields such as user_count, installation_count, id, created_at, updated_at, name, description, notes, application_type, status, managed_by_id, category, source, and workspace_id. Note: workspace_id cannot be updated using this operation.
- **get_single_freshservice_software_by_id** — Get software details in Freshservice by id. Returns id, name, description, notes, user_count, installation_count, category, application_type, status, managed_by_id, publisher_id, source, created_at, updated_at, and workspace_id.
- **list_all_freshservice_softwares** — List all softwares in Freshservice. Returns user_count, installation_count, id, created_at, updated_at, name, publisher_id, description, notes, application_type, status, managed_by_id, category, source, and workspace_id for each software.
- **freshservice_softwares_licenses** — List all licenses for a specific software in Freshservice. Requires id. Returns id, contract_id, created_time, and updated_time for each license.
- **delete_a_freshservice_software_by_id** — Delete a specific software in Freshservice using id. Returns HTTP status 204 No Content upon successful deletion.
- **freshservice_softwares_delete_multiple** — Delete multiple softwares in Freshservice. Requires ids. Returns id and http_code for each deleted software, and error details for invalid ids.
- **create_a_freshservice_software_user** — Add users to a software in bulk in Freshservice. Requires id. Returns application_users including id, created_at, updated_at, user_id, license_id, allocated_date, first_used, last_used, and source for each user.
- **get_single_freshservice_software_user_by_id** — Get details for a specific software-user in Freshservice. Requires id (application id) and id (software-user id). Returns application_user with fields for id, user_id, license_id, created_at, updated_at, allocated_date, first_used, last_used, and source.
- **freshservice_software_users_move** — Move a software user to a different workspace in Freshservice. Requires id. Returns application fields including id, name, application_type, user_count, workspace_id, status, and timestamps.
- **list_all_freshservice_software_users** — List all software-users in Freshservice for a specific software application using id. Returns id, created_at, updated_at, user_id, license_id, allocated_date, first_used, last_used, and source fields for each user.
- **update_a_freshservice_software_user_by_id** — Update Users of a Software in bulk in Freshservice. Requires id. Returns id, created_at, updated_at, user_id, license_id, allocated_date, first_used, last_used, source for each updated user.
- **delete_a_freshservice_software_user_by_id** — Remove users from a specific software in Freshservice. Requires id and user_ids. Returns HTTP 204 No Content on successful removal.
- **create_a_freshservice_software_installation** — Create software-installation for a specific application in Freshservice. Requires id and installation_machine_id. Returns id, created_at, updated_at, installation_path, version, installation_machine_id, user_id, department_id, and installation_date in the response.
- **list_all_freshservice_software_installations** — List all software-installations for a specific application in Freshservice using id. Returns id, created_at, updated_at, installation_path, version, installation_machine_id, user_id, department_id, and installation_date for each installation.
- **delete_a_freshservice_software_installation_by_id** — Delete software-installations in Freshservice by removing devices from a software in bulk. Requires id and device_ids. Returns 204 status if successful with no content.
- **list_all_freshservice_software_relationships** — List all relationships for a specific software in Freshservice. Requires id. Returns relationship fields including id, relationship_type_id, primary_id, primary_type, secondary_id, secondary_type, created_at, and updated_at.
- **get_single_freshservice_contract_by_id** — Get details of a specific contract in Freshservice using id. Returns fields such as name, description, vendor_id, cost, status, contract_number, custom_fields, key dates, and more in the response.
- **list_all_freshservice_contracts** — List all contracts in Freshservice. Returns fields such as id, name, description, vendor_id, start_date, end_date, cost, status, contract_number, contract_type_id, workspace_id, and custom_fields for each contract.
- **freshservice_contracts_move** — Move a contract in Freshservice to a different workspace and optionally modify its visibility group. Requires id. Returns contract fields such as id, name, description, vendor_id, workspace_id, and status. Only for Employee Support Mode accounts.
- **update_a_freshservice_contract_by_id** — Update a contract in Freshservice. Requires id. Cannot update workspace_id through this endpoint. Returns fields such as id, name, vendor_id, status, cost, contract_number, dates, billing_cycle, item_cost_details, custom_fields, and associated asset info in the response.
- **create_a_freshservice_contract** — Create contract in Freshservice. Returns id, name, description, vendor_id, contract_number, status, cost, dates, software_id, billing_cycle, custom_fields, item_cost_details, requester_id, and timestamps in the response.
- **freshservice_contracts_contract_with_assets** — Create a contract with associated assets in Freshservice. Returns id, name, status, vendor_id, contract_number, start_date, end_date, cost, auto_renew, item_cost_details, custom_fields, and related fields in the response.
- **freshservice_contracts_contract_with_attachments** — Create a contract with attachment in Freshservice. Returns contract fields such as id, name, vendor_id, approver_id, start_date, end_date, cost, contract_number, contract_type_id, status, created_at, updated_at, has_attachments in the response. Content-Type must be set to multipart/form-data.
- **freshservice_contracts_submit_for_approval** — Submit a specific contract for approval in Freshservice. Requires id. No content is returned in the response.
- **freshservice_contracts_approve** — Approve a contract in Freshservice. Requires id. No content is returned in the response.
- **freshservice_contracts_reject** — Reject a contract in Freshservice. Requires id. Operation expects a reason_to_reject in the request. Returns no content on success.
- **list_all_freshservice_contract_types** — List all contract types in Freshservice. Returns id, name, description, needs_approval, is_default, created_at, and updated_at for each contract type.
- **list_all_freshservice_contract_type_fields** — List all fields of a contract type in Freshservice using contract_type_id. Returns label, name, required, field_type, data_type, visible_in_renewal, default_field, choices, created_at, and updated_at for each field.
- **list_all_freshservice_contract_type_assets** — List all associated assets of a contract in Freshservice. Requires contract_id. Returns fields such as id, display_id, name, asset_type_id, impact, usage_type, asset_tag, created_at, and updated_at for each associated asset.
- **list_all_freshservice_contract_attachments** — List all attachments of a contract in Freshservice. Requires contract_id. Returns id, content_type, size, name, attachment_url, canonical_url, created_at, and updated_at for each attachment.
- **list_all_freshservice_department_fields** — List all Department Fields in Freshservice. Returns fields such as name, label, mandatory status, is_default_field, created_at, and updated_at in the order they are displayed in the UI.
- **get_single_freshservice_business_hour_by_id** — Get a business-hours configuration in Freshservice. Requires id. Returns fields such as id, created_at, updated_at, name, description, is_default, time_zone, service_desk_hours, list_of_holidays, and workspace_ids.
- **list_all_freshservice_business_hours** — List business-hours in Freshservice. Returns business_hours with fields: id, created_at, updated_at, name, description, is_default, time_zone, service_desk_hours (workday timings), list_of_holidays, workspace_id. By default, only business hours from the primary workspace are returned for Employee Support Mode accounts; to retrieve business hours from other workspaces, use the workspace_id filter.
- **create_a_freshservice_project** — Create a project in Freshservice. Requires name and project_type. Returns id, name, key, description, priority_id, sprint_duration, project_type, start_date, end_date, archived, visibility, manager_id, created_at, updated_at, custom_fields, and attachments if present in the response.
- **update_a_freshservice_project_by_id** — Update a project in Freshservice. Requires id. Returns project fields such as id, name, key, description, status_id, priority_id, manager_id, start_date, end_date, visibility, sprint_duration, custom_fields, attachments (if present), created_at, and updated_at. For updating with attachments, Content-Type must be set to multipart/form-data.
- **get_single_freshservice_project_by_id** — Get details of a project in Freshservice using id. Returns fields such as id, name, key, description, status_id, priority_id, sprint_duration, project_type, start_date, end_date, archived, visibility, manager_id, created_at, updated_at, and custom_fields.
- **list_all_freshservice_projects** — List all projects in Freshservice. Returns id, name, key, description, status_id, priority_id, sprint_duration, project_type, start_date, end_date, archived, visibility, manager_id, created_at, updated_at, and custom_fields in the response.
- **delete_a_freshservice_project_by_id** — Delete a specific project in Freshservice. Requires id. Deleted projects cannot be restored. Returns HTTP 204 No Content indicating successful deletion.
- **freshservice_projects_archive** — Archive a project in Freshservice. Requires id. Returns HTTP 200 OK if successful.
- **freshservice_projects_restore** — Restore an archived project in Freshservice. Requires id. Returns status of the restore operation.
- **list_all_freshservice_project_fields** — List project fields in Freshservice. Returns label, name, type, default (if it's a default field), choices, and mandatory (if the field is mandatory) for each project field.
- **list_all_freshservice_project_templates** — List project templates in Freshservice. Returns id, name, description, template_type, visibility, created_at, and updated_at for each template.
- **create_a_freshservice_project_member** — Add one or more members to a project in Freshservice. Requires id. Returns scheduled_process_status field, which provides the job id to track the background process.
- **create_a_freshservice_project_association** — Create associations between a specific project and given Ticket, Problem, Change, or Asset modules in Freshservice. Requires project_id, module_name, and ids. Returns id and http_code for each association in the response.
- **list_all_freshservice_project_associations** — List project associations for a specific project in Freshservice. Requires project_id and module_name. Returns fields such as id, subject, responder_id, due_by, priority, impact, urgency, description_text, and status.
- **delete_a_freshservice_project_association_by_id** — Delete an association of a project in Freshservice. Requires project_id, module_name, and id. Returns HTTP 204 No Content on success.
- **delete_a_freshservice_project_attachment_by_id** — Delete an attachment of a project in Freshservice. Requires project_id and id. Returns no content on successful deletion.
- **create_a_freshservice_project_task** — Create a project task in Freshservice for the specified project id. Returns task fields including id, title, description, project_id, status_id, priority_id, type_id, created_at, updated_at, display_key, planned dates, assignee_id, reporter_id, parent_id, story_points, sprint_id, version_id, custom_fields, and attachments if provided. For file attachments, Content-Type must be multipart/form-data.
- **update_a_freshservice_project_task_by_id** — Update a project task in Freshservice using project_id and id. Returns fields such as id, title, project_id, description, status_id, priority_id, assignee_id, planned dates, effort, duration, custom_fields, version_id, parent_id, story_points, sprint_id, and attachments in the response. Attachments require Content-Type: multipart/form-data.
- **get_single_freshservice_project_task_by_id** — Get details of a specific project-task in Freshservice using project_id and id. Returns id, title, project_id, description, status_id, priority_id, reporter_id, created_at, updated_at, display_key, planning and assignment fields, and custom_fields.
- **list_all_freshservice_project_tasks** — List all project tasks in Freshservice for the specified id. Returns each task's id, title, project_id, description, status_id, priority_id, reporter_id, created_at, updated_at, display_key, planned_start_date, type_id, assignee_id, planned_end_date, planned_effort, planned_duration, custom_fields, version_id, parent_id, story_points, and sprint_id fields in the response.
- **delete_a_freshservice_project_task_by_id** — Delete a project-task in Freshservice. Requires project_id and id. Deleted tasks cannot be restored. No content is returned in the response.
- **freshservice_project_tasks_filter** — List project-tasks in Freshservice for a specific project using query. Requires id and query. Returns tasks with fields such as id, title, project_id, description, status_id, priority_id, reporter_id, created_at, and more.
- **list_all_freshservice_project_task_type_fields** — List project-task-type-fields in Freshservice. Requires project_id and type_id. Returns fields such as label, name, type, choices, default, and mandatory for each field of the specified task type.
- **list_all_freshservice_project_task_types** — List task types for a project in Freshservice. Requires project_id. Returns id, name, description, created_at, updated_at, and project_id for each task type in the response.
- **list_all_freshservice_project_task_priorities** — List project task priorities in Freshservice using project_id. Returns each priority's id, name, description, project_id, created_at, and updated_at in the response.
- **list_all_freshservice_project_task_statuses** — List all project task statuses in Freshservice for the specified project_id. Returns id, name, description, category_id, project_id, created_at, and updated_at for each status in the response.
- **list_all_freshservice_project_versions** — List all project versions in Freshservice for a specific project_id. Returns id, created_at, updated_at, name, start_date, due_date, description, status_id, owner_id, and project_id fields for each version.
- **list_all_freshservice_project_sprints** — List all project-sprints in Freshservice for a specific project_id. Returns id, title, goal, state, planned_start_date, planned_end_date, project_id, created_at, and updated_at for each sprint.
- **list_all_freshservice_project_memberships** — List all project-memberships in Freshservice for a specified project_id. Returns id, project_id, user_id, access_type, manage_settings, project_manager, created_at, and updated_at for each membership.
- **create_a_freshservice_project_task_association** — Create associations between a task and specific Tickets, Problems, Changes, or Assets in Freshservice. Requires project_id, task_id, and module_name. Returns id and http_code for each associated record in the response.
- **list_all_freshservice_project_task_associations** — List all associations for a project-task in Freshservice by module_name, project_id, and task_id. Returns ticket fields such as subject, responder_id, due_by, priority, impact, urgency, id, description_text, and status.
- **delete_a_freshservice_project_task_association_by_id** — Delete a project-task association in Freshservice. Requires project_id, task_id, module_name, and id. No content is returned in the response upon successful deletion.
- **create_a_freshservice_project_task_id_note** — Create a note for a specific task in Freshservice using project_id and id. Returns note id, body, task_id, user_email_id, attachments, created_at, and updated_at. Attachments' total size must not exceed 26 MB and Content-Type must be multipart/form-data for attachments.
- **list_all_freshservice_project_task_id_notes** — List notes for a specific task in Freshservice using project_id and id. Returns each note's id, body, task_id, user_email_id, attachments (with id, content_type, attachment_url, size, name, created_at, updated_at), created_at, and updated_at.
- **update_a_freshservice_project_task_id_note_by_id** — Update a note in Freshservice. Requires project_id, task_id, and id. Returns id, body, task_id, user_email_id, attachments, created_at, and updated_at fields in the response. Attachments size limit is 26 MB.
- **delete_a_freshservice_project_task_id_note_by_id** — Delete a note in Freshservice using project_id, task_id, and id. Returns HTTP 204 No Content if successful.
- **delete_a_freshservice_project_task_notes_attachment_by_id** — Delete an attachment of a note in Freshservice. Requires project_id, task_id, note_id, and id. Returns a 204 No Content response if successful.
- **delete_a_freshservice_project_task_attachment_by_id** — Delete an attachment of a task in Freshservice using project_id, task_id, and id. Returns no content on success.
- **create_a_freshservice_solution_category** — Create a solution category in Freshservice. Returns the id, name, description, created_at, updated_at, default_category, position, visible_in_portals, and workspace_id fields in the response. If on MSP, workspace_id defaults to 3.
- **update_a_freshservice_solution_category_by_id** — Update solution category in Freshservice. Requires id. Returns id, created_at, updated_at, name, description, default_category, position, visible_in_portals, workspace_id fields in the response.
- **get_single_freshservice_solution_category_by_id** — Get solution-category details in Freshservice. Requires id. Returns fields: id, created_at, updated_at, name, description, default_category, position, visible_in_portals, workspace_id.
- **list_all_freshservice_solution_category** — List solution-category resources in Freshservice. Returns id, created_at, updated_at, name, description, default_category, position, visible_in_portals, and workspace_id for each category. Only categories from the primary workspace are included by default unless workspace_id is specified.
- **delete_a_freshservice_solution_category_by_id** — Delete a solution-category in Freshservice. Requires id. Returns HTTP 204 status on successful deletion.
- **freshservice_solution_folder_create_with_approval** — Create a solution-folder in Freshservice with approval. Returns id, name, description, category_id, visibility, created_at, updated_at, department_ids, approval_settings, default_folder, position, manage_by_group_ids, and workspace_id in the response. Requires required body parameters for folder details and approval.
- **update_a_freshservice_solution_folder_by_id** — Update a solution folder in Freshservice. Requires id. Returns id, name, description, created_at, updated_at, applicable_to_workspace_ids, workspace_id, category_id, position, visibility, approval_settings, default_folder, and manage_by_group_ids fields.
- **get_single_freshservice_solution_folder_by_id** — Get details of a solution-folder in Freshservice. Requires id. Returns id, created_at, updated_at, name, description, category_id, workspace_id, position, visibility, approval_settings, default_folder, manage_by_group_ids, and applicable_to_workspace_ids.
- **list_all_freshservice_solution_folder** — List solution-folder resources in Freshservice for a specific category_id. Returns folders with fields: id, name, description, created_at, updated_at, category_id, position, visibility, approval_settings, default_folder, manage_by_group_ids, department_ids, workspace_id.
- **delete_a_freshservice_solution_folder_by_id** — Delete solution folder in Freshservice. Requires id. Deleted solution folders cannot be restored. Returns a 204 status on success.
- **create_a_freshservice_solution_article** — Create a solution article in Freshservice. Requires title, description, and folder_id. Returns id, title, description, status, folder_id, created_at, updated_at, article_type, tags, keywords, review_date, and other article fields in the response.
- **freshservice_solution_article_link_secondary_language_article** — Create a secondary language solution-article in Freshservice. Requires title, folder_id, language, and parent_id. Returns fields such as id, title, description, article_type, folder_id, language, status, created_at, updated_at, views, and other article details in the response.
- **freshservice_solution_article_create_with_atatchment** — Create a solution article with attachments in Freshservice. Returns fields such as id, title, description, status, folder_id, category_id, attachments, tags, created_at, updated_at, agent_id, views, and workspace_id in the response.
- **freshservice_solution_article_create_from_external_url** — Create a new solution article in Freshservice using title, url, and folder_id. Returns fields such as id, title, created_at, status, folder_id, url, keywords, tags, and workspace_id in the response.
- **freshservice_solution_article_search** — Search solution-article resources in Freshservice by search_term. Returns articles with fields such as id, title, description, status, created_at, updated_at, and workspace_id. Only published, accessible articles are returned.
- **freshservice_solution_article_send_for_approval** — Send solution article in Freshservice to approval. Requires id. Returns fields such as id, title, status, approval_status, author, approvals, created_at, updated_at, and workspace_id in the response.
- **freshservice_solution_article_publish** — Publish a solution article in Freshservice using id. Returns fields such as id, title, status, description, created_at, updated_at, approval_status, category_id, folder_id, attachments, approvals, modified_at, workspace_id, and more.
- **update_a_freshservice_solution_article_by_id** — Update solution article in Freshservice by id. Returns fields such as id, title, description, status, created_at, updated_at, category_id, folder_id, agent_id, tags, attachments, and workspace_id in the response.
- **get_single_freshservice_solution_article_by_id** — Get a specific solution article in Freshservice by id. Returns fields such as id, title, description, status, created_at, updated_at, folder_id, category_id, tags, keywords, attachments, approvals, workspace_id, and other details in the response.
- **list_all_freshservice_solution_article** — List solution articles in Freshservice for a given folder_id. Returns fields including id, title, description, status, approval_status, position, folder_id, category_id, created_at, updated_at, agent_id, views, and workspace_id in the response.
- **delete_a_freshservice_solution_article_by_id** — Delete a specific solution-article in Freshservice. Requires id. No content is returned in the response.
- **list_all_freshservice_service_items** — List service-items in Freshservice. Returns service_items with fields id, name, created_at, updated_at, display_id, category_id, workspace_id, delivery_time, deleted, group_visibility, visibility, and other metadata.
- **get_single_freshservice_service_item_by_id** — Get details of a specific service item in Freshservice using id. Returns fields such as id, name, created_at, updated_at, description, display_id, configs, custom_fields, icon_url, and workspace_id in the response.
- **create_a_freshservice_service_item** — Create a new service item in Freshservice. Requires name, category_id, short_description, description, and visibility. Returns fields including id, name, category_id, created_at, updated_at, workspace_id, cost, visibility, short_description, description, group_visibility, agent_group_visibility, delivery_time, cost_visibility, delivery_time_visibility, agent_group_visibilities, agent_workspace_visibilities, custom_fields, icon_url, and other details about the created service item. workspace_id must not be 1.
- **freshservice_service_items_search** — Search service-items in Freshservice using search_term. Returns fields such as id, name, created_at, updated_at, description, category_id, and workspace_id. Only published items accessible to the user or user_email are returned.
- **list_all_freshservice_service_category** — List service categories in Freshservice. Returns id, name, description, position, workspace_id, created_at, and updated_at for each service category. By default, only categories from the primary workspace are returned.
- **list_all_freshservice_announcements** — List announcements in Freshservice. Returns fields such as id, title, body, visibility, state, is_read, visible_from, visible_till, created_at, updated_at, created_by, workspace_id, groups, agent_groups, additional_emails, and send_email in the response.
- **create_a_freshservice_announcement** — Create an announcement in Freshservice. Returns fields including id, title, body, body_html, visible_from, visible_till, visibility, state, is_read, send_email, departments, groups, created_at, updated_at, created_by, workspace_id, additional_emails, visible_to_workspace_ids, agent_groups, grouped_visibility_options, additional_config, and visible_in_portal in the response. In Freshservice for MSPs, announcements are created using workspace_id=3 by default.
- **get_single_freshservice_announcement_by_id** — Get a specific announcement in Freshservice. Requires id. Returns fields such as id, title, body, body_html, visible_from, visible_till, state, visibility, workspace_id, created_by, created_at, updated_at, groups, agent_groups, is_read, send_email, additional_emails, visible_in_portal, additional_config, and grouped_visibility_options.
- **update_a_freshservice_announcement_by_id** — Update an announcement in Freshservice. Requires id. Returns fields including id, title, body, body_html, visible_from, visible_till, visibility, departments, groups, state, is_read, send_email, additional_emails, created_at, updated_at, created_by, and workspace_id.
- **delete_a_freshservice_announcement_by_id** — Delete an announcement in Freshservice. Requires id. Returns HTTP 200 OK if successful.
- **create_a_freshservice_onboarding_request** — Create an onboarding request in Freshservice. Requires initiator_id and fields. Returns id, created_at, updated_at, status, subject, ticket_id, actors, fields, and lookup_values for the new onboarding request.
- **get_single_freshservice_onboarding_request_by_id** — Get a specific onboarding-request in Freshservice by id. Returns onboarding_request fields including id, created_at, updated_at, status, subject, ticket_id, actors, fields, and lookup_values.
- **list_all_freshservice_onboarding_requests** — List onboarding-requests in Freshservice. Returns id, created_at, updated_at, status, subject, and fields (including cf_employee_name, cf_job_title, cf_date_of_joining, cf_department, cf_location, msf_area_of_expertise, msf_preferred_locations) for each request.
- **list_all_freshservice_onboarding_request_tickets** — List onboarding-request-tickets for a specific onboarding request in Freshservice. Requires id. Returns fields including id, created_at, subject, responder_email, status, predecessor_ticket_id, successor_ticket_ids, and onboarding_context.
- **list_all_freshservice_onboarding_form_fields** — List onboarding-form-fields in Freshservice. Returns fields with placeholder, label, name, position, required, default, field_type, and data_source for each field in the response.
- **create_a_freshservice_offboarding_request** — Create an offboarding request in Freshservice. Returns fields including id, created_at, updated_at, status, subject, ticket_id, actors (with email, name, response_status), fields (employee data, assets, locations), and lookup_values for all provided references. Only users with admin privilege can set initiator_id on behalf of another user.
- **get_single_freshservice_offboarding_request_by_id** — Get information about a specific offboarding request in Freshservice. Requires id. Returns fields like created_at, updated_at, status, subject, ticket_id, actors, fields, and lookup_values for context and detail.
- **list_all_freshservice_offboarding_requests** — List all offboarding-requests in Freshservice. Returns id, created_at, updated_at, status, subject, and fields (details like employee name, department, and assets) for each offboarding request.
- **list_all_freshservice_offboarding_form_fields** — List all offboarding form fields in Freshservice. Returns placeholder, label, name, position, required, default, field_type, data_source, and choices (if present) for each field.
- **list_all_freshservice_offboarding_tickets** — List offboarding-tickets for an offboarding request in Freshservice. Requires id. Returns id, created_at, updated_at, subject, responder_email, status, predecessor_ticket_id, successor_ticket_ids, parent, and offboarding_context fields in the response.
- **list_all_freshservice_custom_objects** — List all custom-objects in Freshservice. Returns id, title, description, updated_at, last_updated_by (with email, id, name), and workspace_id for each custom-object.
- **get_single_freshservice_custom_object_by_id** — Get details about a specific custom object in Freshservice. Requires id. Returns fields like id, name, title, description, workspace_id, fields (with metadata and dropdown options), and meta (total_records_count).
- **create_a_freshservice_custom_object_record** — Create a new custom object record in Freshservice. Requires id. Returns fields such as agent_group, approver, item_name, category_dd1, category_dd2, category_dd3, vendor_information, bo_created_at, bo_updated_at, bo_display_id, bo_created_by, bo_updated_by.
- **list_all_freshservice_custom_object_records** — List all records of a Custom Object in Freshservice using id. Returns key fields such as agent_group, approver, bo_created_at, bo_created_by, bo_display_id, bo_updated_at, bo_updated_by, category_dd1, category_dd2, category_dd3, item_name, and vendor_information in each record.
- **update_a_freshservice_custom_object_record_by_id** — Update a custom-object-record in Freshservice. Requires id and record_id. Returns fields such as agent_group, approver, bo_created_at, bo_created_by, bo_display_id, bo_updated_at, bo_updated_by, category_dd1, category_dd2, category_dd3, item_name, and vendor_information.
- **delete_a_freshservice_custom_object_record_by_id** — Delete a custom object record in Freshservice. Requires id for the custom object and record_id for the specific record. Returns HTTP 202 No Content upon successful deletion.
- **list_all_freshservice_sla_policies** — List SLA policies in Freshservice. Requires workspace_id. Returns id, name, position, is_default, active, deleted, description, workspace_ids, sla_targets, applicable_to, escalation, created_at, and updated_at for each policy.
- **list_all_freshservice_canned_response_folders** — List canned-response-folders in Freshservice. Returns id, name, type, responses_count, created_at, updated_at, and workspace_id for each folder. Only primary workspace folders are returned unless workspace_id filter is used.
- **get_single_freshservice_canned_response_folder_by_id** — Get a specific canned-response-folder in Freshservice. Requires id. Returns fields: id, name, type, responses_count, created_at, updated_at, and workspace_id in the response.
- **freshservice_canned_response_folders_canned_responses** — List all canned responses in a specific canned-response-folder in Freshservice. Requires id. Returns id, title, folder_id, content, content_html, created_at, updated_at, and workspace_id for each canned response.
- **list_all_freshservice_canned_responses** — List canned responses in Freshservice. Returns id, title, folder_id, content, content_html, created_at, updated_at, and workspace_id for each canned response.
- **get_single_freshservice_canned_response_by_id** — Get a specific canned response in Freshservice by id. Returns fields such as id, title, folder_id, content, content_html, created_at, updated_at, workspace_id, and attachments including their details.
- **freshservice_audit_logs_export** — Export audit logs in Freshservice using specified filters such as since, before, and type. Returns audit log entries with fields like log type, actor, timestamps, and related resource changes. Use for account, workflow, change_field, etc.
- **freshservice_attachments_download** — Download an attachment in Freshservice by id. The response returns the raw binary content of the attachment.
- **freshservice_purchase_order_and_contract_attachments_download** — Download a specific purchase order or contract attachment in Freshservice. Requires id. No content is returned in the response.
- **create_a_freshservice_schedule** — Create a schedule in Freshservice. Requires workspace_id, name, agent_group_id, and agent_group_name. Returns fields such as id, name, description, status, agent_group_id, agent_group_name, product_workspace_id, escalation_policies, conditions, and stakeholders.
- **update_a_freshservice_schedule_by_id** — Update a schedule in Freshservice. Requires workspace_id and id. Returns fields: id, name, description, status, agent_group_id, agent_group_name, product_workspace_id, escalate_type_in_overlapcase, business_calendar, shifts, notification_rule, and escalation_policies in the response.
- **list_all_freshservice_schedules** — List all schedules in Freshservice for a workspace. Requires workspace_id. Returns id, name, description, agent_group_id, agent_group_name, and invalid_numbers_present for each schedule in the response.
- **freshservice_schedules_filter** — Filter schedules in Freshservice with workspace_id and schedule_name in query. Returns id, name, description, agent_group_id, agent_group_name, and invalid_numbers_present for each schedule. schedule_name supports 2-255 valid characters.
- **get_single_freshservice_schedule_by_id** — Get schedule details in Freshservice using workspace_id and id. Returns fields including id, name, description, status, agent_group_id, agent_group_name, product_workspace_id, business_calendar, shifts, escalation_policies with conditions, and stakeholders.
- **delete_a_freshservice_schedule_by_id** — Delete a schedule by id in Freshservice. Requires workspace_id and id. No content is returned in the response.
- **create_a_freshservice_schedule_shift** — Create a shift in Freshservice for a specific schedule using workspace_id and schedule_id. Returns id, name, timezone, status, start_date, end_date, and rosters with member and event details in the response.
- **update_a_freshservice_schedule_shift_by_id** — Update a specific schedule-shifts resource in Freshservice. Requires workspace_id, schedule_id, and id. Returns id, name, description, timezone, status, start_date, end_date, rosters (with members and shift events), shift_event_overrides, is_only_overridden_events, and escalation_path in the response.
- **list_all_freshservice_schedule_shifts** — List all shifts in a specific on-call schedule in Freshservice using workspace_id and schedule_id. Returns fields including id, name, description, timezone, status, start_date, end_date, rosters, shift_events, and related user details for each shift.
- **get_single_freshservice_schedule_shift_by_id** — Get details about a specific schedule-shifts in Freshservice using workspace_id, schedule_id, and id. Returns fields such as name, description, timezone, status, start_date, end_date, rosters (with members), shift_events, shift_event_overrides, and escalation_path.
- **delete_a_freshservice_schedule_shift_by_id** — Delete a shift in Freshservice on-call schedule. Requires workspace_id, schedule_id, and id. No content is returned in the response.
- **update_a_freshservice_shift_override_by_id** — Create, update, or delete a shift-override in Freshservice for a specific workspace_id, schedule_id, and shift_id. Returns fields such as shift id, name, timezone, status, start_date, rosters, and shift_events with override status in the response.
- **list_all_freshservice_user_shift_oncall_calender_events** — List oncall calendar events for a user shift in Freshservice. Requires start_time, end_time, shift_id, schedule_id, and user_id. Returns shift_events with event and user details including id, event time, overridden, roster_type, shift, and schedule info.
- **list_all_freshservice_user_schedule_oncall_calender_events** — List oncall calendar events for a user in Freshservice using schedule_id, start_time, end_time, and user_id. Returns shift_events with event_start_date_time, event_end_date_time, user details, shift details, schedule details, overridden, and roster_type.
- **list_all_freshservice_incidents** — List all incidents in Freshservice for a given status_page_id. Returns incidents with fields: id, title, description, status, type, created_at, updated_at, started_at, ended_at, impacted_services, and ticket_id.
- **get_single_freshservice_incident_by_id** — Get incident details in Freshservice. Requires ticket_id, status_page_id, and id. Returns id, title, description, status, created_at, updated_at, started_at, ended_at, impacted_services, user_id, and ticket_id fields in the response.
- **create_a_freshservice_incident** — Create an incident in Freshservice for a specific ticket_id and status_page_id. Returns id, title, description, started_at, ended_at, impacted_services, status, created_at, updated_at, user_id, and ticket_id in the response.
- **update_a_freshservice_incident_by_id** — Update an incident in Freshservice using ticket_id, status_page_id, and id. Returns fields such as created_at, updated_at, description, impacted_services, started_at, ended_at, status, title, user_id, and ticket_id in the response.
- **delete_a_freshservice_incident_by_id** — Delete an incident in Freshservice. Requires ticket_id, status_page_id, and id. Deleted incidents are permanently lost. No content is returned in the response.
- **list_all_freshservice_incident_updates** — List all updates for an incident in Freshservice. Requires ticket_id, status_page_id, and incident_id. Returns id, message, created_at, updated_at, posted_on, user_id, and status_id for each update in the response.
- **create_a_freshservice_incident_update** — Create an incident update in Freshservice. Requires ticket_id, status_page_id, and incident_id. Returns incident_update fields: id, message, posted_on, created_at, updated_at, user_id, and status_id.
- **update_a_freshservice_incident_update_by_id** — Edit an incident update in Freshservice. Requires ticket_id, status_page_id, incident_id, and id. Returns created_at, id, message, posted_on, updated_at, user_id, and status_id fields in the response.
- **delete_a_freshservice_incident_update_by_id** — Delete an incident update in Freshservice. Requires ticket_id, status_page_id, incident_id, and id. The update is permanently deleted and key response is HTTP 204 No Content.
- **list_all_freshservice_incident_statuses** — List all incident statuses in Freshservice for the given status_page_id. Returns id, position, name, and color for each incident status.
- **list_all_freshservice_maintenances** — List all maintenances in Freshservice for a specific status_page_id. Returns maintenances with fields: id, title, description, status, started_at, ended_at, impacted_services, notifications, created_at, updated_at, user_id, maintenance_window_id.
- **get_single_freshservice_change_maintenance_by_id** — Get details about a specific change-maintenance in Freshservice. Requires change_id, status_page_id, and id. Returns key fields: created_at, description, started_at, ended_at, status, title, impacted_services, notifications, updated_at, user_id, maintenance_window_id.
- **create_a_freshservice_change_maintenance** — Create a maintenance from a change in Freshservice. Requires change_id and status_page_id. Returns fields such as id, title, description, started_at, ended_at, impacted_services, notifications, status, user_id, maintenance_window_id, created_at, and updated_at in the response.
- **update_a_freshservice_change_maintenance_by_id** — Update a maintenance from a change in Freshservice using change_id, status_page_id, and id. Returns created_at, description, ended_at, id, impacted_services, notifications, started_at, status, title, updated_at, user_id, and maintenance_window_id in the response.
- **delete_a_freshservice_change_maintenance_by_id** — Delete a maintenance associated with a change in Freshservice. Requires change_id, status_page_id, and id. No content is returned in the response on success.
- **get_single_freshservice_maintenance_window_maintenance_by_id** — Get maintenance-window-maintenances in Freshservice using maintenance_window_id, status_page_id, and id. Returns fields such as id, title, status, description, impacted_services, notifications, started_at, ended_at, created_at, updated_at, user_id, and maintenance_window_id.
- **create_a_freshservice_maintenance_window_maintenance** — Create a maintenance for a maintenance window in Freshservice. Requires maintenance_window_id and status_page_id. Returns id, title, description, started_at, ended_at, status, impacted_services, notifications, user_id, created_at, updated_at, and maintenance_window_id.
- **update_a_freshservice_maintenance_window_maintenance_by_id** — Update a maintenance for a maintenance window in Freshservice. Requires maintenance_window_id, status_page_id, and id. Returns fields such as created_at, description, ended_at, id, impacted_services, notifications, started_at, status, title, updated_at, user_id, and maintenance_window_id in the response.
- **delete_a_freshservice_maintenance_window_maintenance_by_id** — Delete a maintenance from a maintenance window in Freshservice. Requires maintenance_window_id, status_page_id, and id. A maintenance once deleted is permanently lost. Returns no content in response.
- **list_all_freshservice_maintenance_statuses** — List all maintenance statuses in Freshservice for a specified status_page_id. Returns id, position, name, and color fields for each maintenance status in the response.
- **list_all_freshservice_change_maintenance_updates** — List all maintenance updates for a specific maintenance in Freshservice. Requires change_id, status_page_id, and id. Returns created_at, id, message, posted_on, updated_at, user_id, and status_id for each update.
- **create_a_freshservice_change_maintenance_update** — Create a maintenance update from a change in Freshservice. Requires change_id, status_page_id, and maintenance_id. Returns id, message, posted_on, created_at, updated_at, user_id, and status_id in the response.
- **update_a_freshservice_change_maintenance_update_by_id** — Update a maintenance update in Freshservice. Requires change_id, status_page_id, maintenance_id, and id. Returns maintenance update details including id, message, status_id, posted_on, created_at, updated_at, and user_id.
- **delete_a_freshservice_change_maintenance_update_by_id** — Delete a maintenance update from a change in Freshservice. Requires change_id, status_page_id, maintenance_id, and id. The response returns HTTP 204 No Content upon successful deletion. Deleted updates are permanently lost.
- **list_all_freshservice_status_pages** — List all status pages in Freshservice. Returns an array of status pages with fields: id, domain, name, custom_domain, private, and workspace_id. Requires workspace_id.
- **list_all_freshservice_service_components** — List all service components for a Freshservice status page. Requires status_page_id. Returns each service component's id, name, position, settings, status, type, and nested components in the response.
- **get_single_freshservice_service_component_by_id** — Get a specific service component in Freshservice using status_page_id and id. Returns details such as id, name, position, status, type, components, and settings including start_date, service_id, and uptime_history.

## How it works

1. **Link your customer's Freshservice account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Freshservice.** The Proxy API is a 1-to-1 mapping of the Freshservice API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Automate IT provisioning from your HR platform** — HR SaaS companies can trigger Freshservice onboarding and offboarding requests when employees are hired or terminated, automatically spinning up child tickets for laptop procurement, software provisioning, and access setup — without manual IT intervention.
- **Escalate security vulnerabilities into ITSM remediation workflows** — Cybersecurity and vulnerability management platforms can correlate detected risks with Freshservice assets and software inventories, then automatically create tickets or problems assigned to the right IT group for patching and remediation.
- **Push monitoring alerts into Freshservice incident management** — Observability and infrastructure monitoring tools can feed alerts into Freshservice, check on-call schedules to identify the right responder, and promote critical alerts to major incidents with full asset context from the CMDB.
- **Sync time entries and contracts for MSP billing** — Billing and invoicing platforms serving MSPs can pull time entries logged against tickets per workspace, along with contract and software license data, to generate accurate client invoices without manual data collection.
- **Bridge engineering issues with IT change management** — DevOps and project management tools can create and update Freshservice changes, problems, and releases programmatically, ensuring IT teams have visibility into upcoming deployments and can manage CAB approvals in their existing workflow.

## What you can build

- **Two-way ticket sync with conversation threading** — Keep tickets synchronized between your product and Freshservice, including public replies and private notes, so support context is never lost across systems.
- **Automated employee onboarding and offboarding triggers** — Create Freshservice onboarding or offboarding requests directly from your HR or identity platform, triggering multi-department provisioning workflows with a single API call.
- **Asset and software inventory enrichment** — Pull the full Freshservice asset directory — hardware, software, components, and relationships — into your security, compliance, or endpoint management product for real-time inventory correlation.
- **On-call schedule-aware incident routing** — Query Freshservice on-call schedules and shifts to identify the right responder before creating or escalating a major incident, reducing mean time to acknowledge.
- **Unified user and group directory sync** — Leverage Truto's Unified User Directory API to sync agents, requesters, groups, roles, and workspaces between your product and Freshservice without writing Freshservice-specific code.
- **Change advisory board automation** — Programmatically create changes, manage CAB approval groups, and send approval reminders so your deployment or release tool can gate rollouts on Freshservice CAB sign-off.

## FAQs

### What authentication method does the Freshservice integration use?

Freshservice supports API key-based authentication. Your end users provide their Freshservice API key and subdomain, and Truto handles credential storage, token management, and request signing so you don't have to.

### Which Freshservice resources are covered by Truto's Unified APIs?

Truto's Unified User Directory API covers Freshservice agents, requesters, agent groups, requester groups, roles, and workspaces. The Unified Ticketing API covers ticket attachments. All other Freshservice resources — tickets, problems, changes, releases, assets, software, alerts, on-call schedules, onboarding/offboarding, and more — are accessible via Truto's pass-through proxy using the full set of native Freshservice tools.

### Can I access custom fields on Freshservice tickets and assets?

Yes. Freshservice exposes field metadata endpoints for tickets, problems, releases, agents, requesters, departments, asset types, contracts, and projects. You can use list_all_freshservice_ticket_fields and similar tools to dynamically discover custom fields and include them in create or update operations.

### Does Truto handle pagination for Freshservice list endpoints?

Yes. Truto automatically handles pagination across all Freshservice list endpoints, so you receive complete result sets without manually managing page tokens or offsets.

### Can I filter tickets and assets without pulling the entire dataset?

Yes. Freshservice provides dedicated filter endpoints for tickets, requesters, departments, locations, assets, releases, and project tasks. You can use tools like freshservice_tickets_filter, freshservice_assets_filter, and freshservice_requesters_filter_requester to query by specific criteria server-side.

### Is multi-workspace (MSP) support available through the integration?

Yes. The integration includes full CRUD operations on Freshservice Workspaces, along with workspace field metadata. This allows MSP-focused SaaS products to map client tenants to Freshservice workspaces and scope tickets, assets, and users accordingly.

## Related reading

- [How Do I Integrate With the Freshservice API? (2026 Engineering Guide)](https://truto.one/blog/how-do-i-integrate-with-the-freshservice-api-2026-guide/) — A complete engineering guide to integrating the Freshservice API in 2026 — covering Basic Auth, minute-level rate limits, page-based pagination quirks, and webhook setup.
