> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshservice

> How to set up the Freshservice connector, plus the actions and events that are available.

![Freshservice](https://stackone-logos.com/api/freshdesk/filled/svg)

Previewv2.0.2[See changelog](https://docs.stackone.com/connectors/freshservice/changelog.md)

[101 actions](#actions) · [1 event](#events) · 1 auth method

ITSM
Ticketing
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/freshservice/guides/connector-profile/api-key.md)
>
> Agent access to your Freshservice account is required to retrieve an API key.

Optionally, configure receiving Events for Freshservice into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/freshservice/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/freshservice/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

101 actions

ActionDescription

List Agents`freshservice_list_agents`

Retrieve a list of all agents

Get Agent`freshservice_get_agent`

Retrieve a specific agent by ID

Get Authenticated Agent`freshservice_get_authenticated_agent`

Retrieve the currently authenticated agent's profile

Create Agent`freshservice_create_agent`

Create a new agent in Freshservice

Update Agent`freshservice_update_agent`

Update an existing agent

Deactivate Agent`freshservice_deactivate_agent`

Deactivate an agent

Filter Agents`freshservice_filter_agents`

Search agents using query language

Forget Agent`freshservice_forget_agent`

Permanently delete an agent and their tickets

List Assets`freshservice_list_assets`

Retrieve a list of all assets

Get Asset`freshservice_get_asset`

Retrieve a specific asset by display ID

Create Asset`freshservice_create_asset`

Create a new asset

Update Asset`freshservice_update_asset`

Update an existing asset

Delete Asset`freshservice_delete_asset`

Delete an asset (moves to trash)

Filter Assets`freshservice_filter_assets`

Search assets using query language

List Changes`freshservice_list_changes`

Retrieve a list of all changes

Get Change`freshservice_get_change`

Retrieve a specific change by ID

Create Change`freshservice_create_change`

Create a new change request

Update Change`freshservice_update_change`

Update an existing change

Delete Change`freshservice_delete_change`

Delete a change

List Contracts`freshservice_list_contracts`

Retrieve a list of all contracts

Get Contract`freshservice_get_contract`

Retrieve a specific contract by ID

Create Contract`freshservice_create_contract`

Create a new contract

Update Contract`freshservice_update_contract`

Update an existing contract

Submit Contract For Approval`freshservice_submit_contract_for_approval`

Submit a contract for approval

Approve Contract`freshservice_approve_contract`

Approve a pending contract

Reject Contract`freshservice_reject_contract`

Reject a pending contract

List Contract Types`freshservice_list_contract_types`

Retrieve all contract types

List Departments`freshservice_list_departments`

Retrieve a list of all departments

Get Department`freshservice_get_department`

Retrieve a specific department by ID

Create Department`freshservice_create_department`

Create a new department

Update Department`freshservice_update_department`

Update an existing department

Delete Department`freshservice_delete_department`

Delete a department

Filter Departments`freshservice_filter_departments`

Search departments using query language

List Groups`freshservice_list_groups`

Retrieve a list of all groups

Get Group`freshservice_get_group`

Retrieve a specific group by ID

Create Group`freshservice_create_group`

Create a new group

Update Group`freshservice_update_group`

Update an existing group

Delete Group`freshservice_delete_group`

Delete a group

Get Unified Credentials`freshservice_unified_get_me`

Get the current Freshservice connection's unified credentials and identity.

List Unified Groups`freshservice_unified_list_groups`

List unified groups in Freshservice.

Get Unified Group`freshservice_unified_get_group`

Get a unified Freshservice group by ID.

List Unified Organizations`freshservice_unified_list_organizations`

List the Freshservice tenant this connection is attached to, as a single organization.

Get Unified Organization`freshservice_unified_get_organization`

Get the Freshservice tenant organization record.

List Unified Roles`freshservice_unified_list_roles`

List unified roles in Freshservice.

Get Unified Role`freshservice_unified_get_role`

Get a unified Freshservice role by ID.

List Unified Users`freshservice_unified_list_users`

List unified users in Freshservice.

Get Unified User`freshservice_unified_get_user`

Get a unified Freshservice user by ID.

List Locations`freshservice_list_locations`

Retrieve a list of all locations

List Problems`freshservice_list_problems`

Retrieve a list of all problems

Get Problem`freshservice_get_problem`

Retrieve a specific problem by ID

Create Problem`freshservice_create_problem`

Create a new problem

Update Problem`freshservice_update_problem`

Update an existing problem

Delete Problem`freshservice_delete_problem`

Delete a problem

List Releases`freshservice_list_releases`

Retrieve a list of all releases

Get Release`freshservice_get_release`

Retrieve a specific release by ID

Create Release`freshservice_create_release`

Create a new release

Update Release`freshservice_update_release`

Update an existing release

Delete Release`freshservice_delete_release`

Delete a release

List Requesters`freshservice_list_requesters`

Retrieve a list of all requesters

Get Requester`freshservice_get_requester`

Retrieve a specific requester by ID

Filter Requesters`freshservice_filter_requesters`

Search requesters using query language

Create Requester`freshservice_create_requester`

Create a new requester

Update Requester`freshservice_update_requester`

Update an existing requester

Deactivate Requester`freshservice_deactivate_requester`

Deactivate a requester

Forget Requester`freshservice_forget_requester`

Permanently delete a requester's data

List Solution Categories`freshservice_list_solution_categories`

Retrieve all solution categories

Get Solution Category`freshservice_get_solution_category`

Retrieve a specific solution category by ID

Create Solution Category`freshservice_create_solution_category`

Create a new solution category

Update Solution Category`freshservice_update_solution_category`

Update an existing solution category

Delete Solution Category`freshservice_delete_solution_category`

Delete a solution category

Get Solution Folder`freshservice_get_solution_folder`

Retrieve a specific solution folder by ID

Create Solution Folder`freshservice_create_solution_folder`

Create a new solution folder

Update Solution Folder`freshservice_update_solution_folder`

Update an existing solution folder

Delete Solution Folder`freshservice_delete_solution_folder`

Delete a solution folder

List Solution Folders`freshservice_list_solution_folders`

Retrieve all solution folders

List Solution Articles`freshservice_list_solution_articles`

Retrieve all knowledge base articles

Get Solution Article`freshservice_get_solution_article`

Retrieve a specific solution article by ID

Create Solution Article`freshservice_create_solution_article`

Create a new knowledge base article

Update Solution Article`freshservice_update_solution_article`

Update an existing knowledge base article

Delete Solution Article`freshservice_delete_solution_article`

Delete a solution article (moves to trash)

List Tickets`freshservice_list_tickets`

Retrieve a paginated list of all tickets

Get Ticket`freshservice_get_ticket`

Retrieve a single ticket by ID

Create Ticket`freshservice_create_ticket`

Create a new support ticket

Update Ticket`freshservice_update_ticket`

Update an existing ticket

Delete Ticket`freshservice_delete_ticket`

Delete a ticket (moves to trash)

Filter Tickets`freshservice_filter_tickets`

Search tickets using query language

List Ticket Conversations`freshservice_list_ticket_conversations`

Retrieve all conversations for a ticket

Create Ticket Reply`freshservice_create_ticket_reply`

Add a public reply to a ticket

List Ticket Tasks`freshservice_list_ticket_tasks`

Retrieve all tasks for a ticket

Create Ticket Task`freshservice_create_ticket_task`

Create a task on a ticket

Get Ticket Task`freshservice_get_ticket_task`

Retrieve a specific task on a ticket

Update Ticket Task`freshservice_update_ticket_task`

Update a task on a ticket

Delete Ticket Task`freshservice_delete_ticket_task`

Delete a task from a ticket

List Ticket Time Entries`freshservice_list_ticket_time_entries`

Retrieve all time entries for a ticket

Create Ticket Time Entry`freshservice_create_ticket_time_entry`

Log time spent on a ticket

Get Ticket Time Entry`freshservice_get_ticket_time_entry`

Retrieve a specific time entry for a ticket

Update Ticket Time Entry`freshservice_update_ticket_time_entry`

Update a time entry on a ticket

Delete Ticket Time Entry`freshservice_delete_ticket_time_entry`

Delete a time entry from a ticket

Create Child Ticket`freshservice_create_child_ticket`

Create a child ticket under an existing ticket

Get Ticket Activity`freshservice_get_ticket_activity`

Retrieve activity log for a ticket

List Vendors`freshservice_list_vendors`

Retrieve a list of all vendors

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

Freshservice Webhook`freshservice_webhook_event`

Processes inbound Freshservice Workflow Automator ("Trigger Webhook") events.

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.