> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/freshservice.md).

# Freshservice

Freshservice is an IT service management platform. Manage tickets, knowledge base articles, agents, and more.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector             | Authentication |
| --------------------- | -------------- |
| Freshservice          | Credentials    |
| Freshservice (OAuth2) | OAuth sign-in  |

#### Freshservice

Connect to Freshservice using an API key. Generate your API key from your Freshservice Profile Settings.

**Set up in Freshservice**

1. Sign in to your Freshservice portal and click your profile picture (top right), then open Profile Settings.
2. Find your API key on the Profile Settings page (below the Delegate Approvals / change-password section); complete the CAPTCHA if prompted, then copy the key.
3. Note your Freshservice domain (the `yourcompany.freshservice.com` URL you sign in with).

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Freshservice**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                         |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Domain        | Yes      | Your Freshservice subdomain (e.g., 'yourcompany' for yourcompany.freshservice.com).                                                                   |
| API Key       | Yes      | Your Freshservice API key from Profile Settings. [Provider instructions](https://support.freshservice.com/en/support/solutions/articles/50000000306). |

**Provider documentation:** [Setup reference](https://support.freshservice.com/support/solutions/articles/50000000306-where-do-i-find-my-api-key-).

#### Freshservice (OAuth2)

Connect to Freshservice using OAuth2. Requires an app registered in the Freshworks Developer Portal.

**Set up in Freshservice**

1. Register an app for Freshservice in the Freshworks Developer Portal to obtain OAuth2 credentials for your account.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Freshservice (OAuth2)**.
2. Complete the connector configuration below. If you do not have access to these settings, ask your StackAI administrator to configure the connector.
3. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
4. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connector configuration**

| StackAI field | Required  | What to enter                                                                                                                                            |
| ------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth Scopes  | Read-only | OAuth scopes for Freshservice API access. This value is shown for reference; it is not an editable credential.                                           |
| Client ID     | Yes       | OAuth 2.0 Client ID from the Freshworks Developer Portal. Register your app to obtain this. [Provider instructions](https://developers.freshworks.com/). |
| Client Secret | Yes       | OAuth 2.0 Client Secret from the Freshworks Developer Portal.                                                                                            |
| Redirect URI  | Read-only | Use this redirect URI when configuring your OAuth application. This value is shown for reference; it is not an editable credential.                      |
| Domain        | Yes       | Your Freshservice subdomain (e.g., 'yourcompany' for yourcompany.freshservice.com).                                                                      |

**Provider documentation:** [Setup reference](https://developers.freshservice.com/docs/oauth/).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Freshservice** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Solution Categories

List all solution categories in the Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field     | Type            | Required | Description                                                                       |
| --------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Workspace | select (string) | No       | The workspace to filter categories by. Options load from the selected connection. |
| Limit     | integer         | No       | Maximum number of categories to return.                                           |

**Outputs**

| Field       | Type          | Description                          |
| ----------- | ------------- | ------------------------------------ |
| Categories  | object\_array | List of solution categories.         |
| Total Count | integer       | Total number of categories returned. |

#### Create Solution Category

Create a new solution category in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field       | Type   | Required | Description                           |
| ----------- | ------ | -------- | ------------------------------------- |
| Name        | string | Yes      | Name of the solution category.        |
| Description | string | No       | Description of the solution category. |

**Outputs**

| Field       | Type    | Description                         |
| ----------- | ------- | ----------------------------------- |
| Category ID | integer | The category ID.                    |
| Name        | string  | The category name.                  |
| Description | string  | The category description.           |
| Created At  | string  | When the category was created.      |
| Updated At  | string  | When the category was last updated. |

#### Get Solution Category

Get a specific solution category from Freshservice by ID.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field       | Type   | Required | Description               |
| ----------- | ------ | -------- | ------------------------- |
| Category ID | string | Yes      | The solution category ID. |

**Outputs**

| Field       | Type    | Description                         |
| ----------- | ------- | ----------------------------------- |
| Category ID | integer | The category ID.                    |
| Name        | string  | The category name.                  |
| Description | string  | The category description.           |
| Created At  | string  | When the category was created.      |
| Updated At  | string  | When the category was last updated. |

#### Update Solution Category

Update a solution category in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field       | Type   | Required | Description                                   |
| ----------- | ------ | -------- | --------------------------------------------- |
| Category ID | string | Yes      | The solution category ID.                     |
| Name        | string | No       | Updated name of the solution category.        |
| Description | string | No       | Updated description of the solution category. |

**Outputs**

| Field       | Type    | Description                         |
| ----------- | ------- | ----------------------------------- |
| Category ID | integer | The category ID.                    |
| Name        | string  | The category name.                  |
| Description | string  | The category description.           |
| Created At  | string  | When the category was created.      |
| Updated At  | string  | When the category was last updated. |

#### Delete Solution Category

Delete a solution category from Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field       | Type   | Required | Description               |
| ----------- | ------ | -------- | ------------------------- |
| Category ID | string | Yes      | The solution category ID. |

**Outputs**

| Field      | Type   | Description                              |
| ---------- | ------ | ---------------------------------------- |
| Deleted ID | string | The ID of the deleted solution category. |

#### List Solution Folders

List all solution folders in the Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field    | Type            | Required | Description                                                                   |
| -------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Category | select (string) | No       | The category to filter folders by. Options load from the selected connection. |
| Limit    | integer         | No       | Maximum number of folders to return.                                          |

**Outputs**

| Field       | Type          | Description                       |
| ----------- | ------------- | --------------------------------- |
| Folders     | object\_array | List of solution folders.         |
| Total Count | integer       | Total number of folders returned. |

#### Create Solution Folder

Create a new solution folder in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field       | Type             | Required | Description                                                                                                                                   |
| ----------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Name        | string           | Yes      | Name of the solution folder.                                                                                                                  |
| Category    | select (string)  | Yes      | The parent category for this folder. Options load from the selected connection.                                                               |
| Description | string           | No       | Description of the solution folder.                                                                                                           |
| Visibility  | select (integer) | No       | The visibility setting of the folder. Available values: All Users, Logged in Users, Agents Only, Departments, Agent Groups, Contact Segments. |

**Outputs**

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Folder ID   | integer | The folder ID.                    |
| Name        | string  | The folder name.                  |
| Description | string  | The folder description.           |
| Category ID | integer | The parent category ID.           |
| Visibility  | integer | The folder visibility setting.    |
| Created At  | string  | When the folder was created.      |
| Updated At  | string  | When the folder was last updated. |

#### Get Solution Folder

Get a specific solution folder from Freshservice by ID.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field     | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| Folder ID | string | Yes      | The solution folder ID. |

**Outputs**

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Folder ID   | integer | The folder ID.                    |
| Name        | string  | The folder name.                  |
| Description | string  | The folder description.           |
| Category ID | integer | The parent category ID.           |
| Visibility  | integer | The folder visibility setting.    |
| Created At  | string  | When the folder was created.      |
| Updated At  | string  | When the folder was last updated. |

#### Update Solution Folder

Update a solution folder in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field       | Type             | Required | Description                                                                                                                                   |
| ----------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Folder ID   | string           | Yes      | The solution folder ID.                                                                                                                       |
| Name        | string           | No       | Updated name of the solution folder.                                                                                                          |
| Description | string           | No       | Updated description of the solution folder.                                                                                                   |
| Visibility  | select (integer) | No       | The visibility setting of the folder. Available values: All Users, Logged in Users, Agents Only, Departments, Agent Groups, Contact Segments. |

**Outputs**

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Folder ID   | integer | The folder ID.                    |
| Name        | string  | The folder name.                  |
| Description | string  | The folder description.           |
| Category ID | integer | The parent category ID.           |
| Visibility  | integer | The folder visibility setting.    |
| Created At  | string  | When the folder was created.      |
| Updated At  | string  | When the folder was last updated. |

#### Delete Solution Folder

Delete a solution folder from Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field     | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| Folder ID | string | Yes      | The solution folder ID. |

**Outputs**

| Field      | Type   | Description                            |
| ---------- | ------ | -------------------------------------- |
| Deleted ID | string | The ID of the deleted solution folder. |

#### List Solution Articles in Folder

List all solution articles in a Freshservice folder.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field  | Type             | Required | Description                                                                           |
| ------ | ---------------- | -------- | ------------------------------------------------------------------------------------- |
| Folder | select (integer) | Yes      | The solution folder to list articles from. Options load from the selected connection. |
| Limit  | integer          | No       | Maximum number of articles to return.                                                 |

**Outputs**

| Field       | Type          | Description                        |
| ----------- | ------------- | ---------------------------------- |
| Articles    | object\_array | List of solution articles.         |
| Total Count | integer       | Total number of articles returned. |

#### Create Solution Article

Create a new solution article in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`, `freshservice.solutions.publish`.

**Inputs**

| Field          | Type             | Required | Description                                                                     |
| -------------- | ---------------- | -------- | ------------------------------------------------------------------------------- |
| Title          | string           | Yes      | Title of the solution article.                                                  |
| Description    | string           | No       | HTML content/body of the article (not needed for external URL articles).        |
| Folder         | select (integer) | Yes      | The folder to create the article in. Options load from the selected connection. |
| Status         | select (integer) | No       | Publication status of the article. Available values: Draft, Published.          |
| Article Type   | select (integer) | No       | Type of the article. Available values: Permanent, Workaround.                   |
| Tags           | string\_array    | No       | Tags to associate with the article.                                             |
| Keywords       | string\_array    | No       | Keywords for search optimization.                                               |
| Attachment URL | string           | No       | URL of a file to attach to the article.                                         |
| External URL   | string           | No       | Create the article from an external URL instead of writing content inline.      |

**Outputs**

| Field        | Type    | Description                        |
| ------------ | ------- | ---------------------------------- |
| Article ID   | integer | The article ID.                    |
| Title        | string  | The article title.                 |
| Description  | string  | The article content.               |
| URL          | string  | The external URL of the article.   |
| Status       | integer | The article status.                |
| Folder ID    | integer | The parent folder ID.              |
| Article Type | integer | The article type.                  |
| Created At   | string  | When the article was created.      |
| Updated At   | string  | When the article was last updated. |

#### Get Solution Article

Get a specific solution article from Freshservice by ID.

**Required permissions:** `freshservice.solutions.view`.

**Inputs**

| Field      | Type   | Required | Description              |
| ---------- | ------ | -------- | ------------------------ |
| Article ID | string | Yes      | The solution article ID. |

**Outputs**

| Field        | Type    | Description                        |
| ------------ | ------- | ---------------------------------- |
| Article ID   | integer | The article ID.                    |
| Title        | string  | The article title.                 |
| Description  | string  | The article content.               |
| Status       | integer | The article status.                |
| Folder ID    | integer | The parent folder ID.              |
| Article Type | integer | The article type.                  |
| Created At   | string  | When the article was created.      |
| Updated At   | string  | When the article was last updated. |

#### Update Solution Article

Update a solution article in Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`, `freshservice.solutions.publish`.

**Inputs**

| Field        | Type             | Required | Description                                                            |
| ------------ | ---------------- | -------- | ---------------------------------------------------------------------- |
| Article ID   | string           | Yes      | The solution article ID.                                               |
| Title        | string           | No       | Updated title of the article.                                          |
| Description  | string           | No       | Updated HTML content/body of the article.                              |
| Article Type | select (integer) | No       | Type of the article. Available values: Permanent, Workaround.          |
| Status       | select (integer) | No       | Publication status of the article. Available values: Draft, Published. |
| Tags         | string\_array    | No       | Updated tags for the article.                                          |
| Keywords     | string\_array    | No       | Updated keywords for search optimization.                              |

**Outputs**

| Field        | Type    | Description                        |
| ------------ | ------- | ---------------------------------- |
| Article ID   | integer | The article ID.                    |
| Title        | string  | The article title.                 |
| Description  | string  | The article content.               |
| Status       | integer | The article status.                |
| Folder ID    | integer | The parent folder ID.              |
| Article Type | integer | The article type.                  |
| Created At   | string  | When the article was created.      |
| Updated At   | string  | When the article was last updated. |

#### Delete Solution Article

Delete a solution article from Freshservice knowledge base.

**Required permissions:** `freshservice.solutions.manage`.

**Inputs**

| Field      | Type   | Required | Description              |
| ---------- | ------ | -------- | ------------------------ |
| Article ID | string | Yes      | The solution article ID. |

**Outputs**

| Field      | Type   | Description                             |
| ---------- | ------ | --------------------------------------- |
| Deleted ID | string | The ID of the deleted solution article. |

#### List Tickets

List tickets in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field   | Type    | Required | Description                                         |
| ------- | ------- | -------- | --------------------------------------------------- |
| Limit   | integer | No       | Maximum number of tickets to return.                |
| Filters | object  | No       | Optional filters to search tickets by field values. |

**Outputs**

| Field       | Type          | Description                       |
| ----------- | ------------- | --------------------------------- |
| Tickets     | object\_array | List of tickets.                  |
| Total Count | integer       | Total number of tickets returned. |

#### Create Ticket

Create a new ticket in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field           | Type             | Required | Description                                                              |
| --------------- | ---------------- | -------- | ------------------------------------------------------------------------ |
| Requester Email | string           | Yes      | Email address of the requester.                                          |
| Subject         | string           | Yes      | Subject of the ticket.                                                   |
| Description     | string           | Yes      | HTML content/body of the ticket.                                         |
| Status          | select (integer) | Yes      | Status of the ticket. Available values: Open, Pending, Resolved, Closed. |
| Priority        | select (integer) | Yes      | Priority of the ticket. Available values: Low, Medium, High, Urgent.     |
| Urgency         | select (integer) | No       | Urgency of the ticket. Available values: Low, Medium, High.              |
| Impact          | select (integer) | No       | Impact of the ticket. Available values: Low, Medium, High.               |
| Category        | string           | No       | Category of the ticket.                                                  |
| Tags            | string\_array    | No       | Tags to associate with the ticket.                                       |
| Ticket Note     | string           | No       | An optional private note to add to the ticket after it is created.       |

**Outputs**

| Field        | Type    | Description                       |
| ------------ | ------- | --------------------------------- |
| Ticket ID    | integer | The created ticket's ID.          |
| Subject      | string  | The ticket subject.               |
| Description  | string  | The ticket description.           |
| Status       | integer | The ticket status.                |
| Priority     | integer | The ticket priority.              |
| Requester ID | integer | The requester's ID.               |
| Group ID     | integer | The assigned group's ID.          |
| Type         | string  | The ticket type.                  |
| Created At   | string  | When the ticket was created.      |
| Updated At   | string  | When the ticket was last updated. |
| Due By       | string  | The ticket due date.              |

#### Get Ticket

Get a ticket by ID from Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field                 | Type    | Required | Description                                                                |
| --------------------- | ------- | -------- | -------------------------------------------------------------------------- |
| Ticket ID             | string  | Yes      | The ticket ID to fetch.                                                    |
| Include Conversations | boolean | No       | Toggle to include conversations and notes with the ticket. Default: false. |

**Outputs**

| Field         | Type          | Description                       |
| ------------- | ------------- | --------------------------------- |
| Ticket ID     | integer       | The ticket ID.                    |
| Subject       | string        | The ticket subject.               |
| Description   | string        | The ticket description.           |
| Status        | integer       | The ticket status.                |
| Priority      | integer       | The ticket priority.              |
| Requester ID  | integer       | The requester's ID.               |
| Group ID      | integer       | The assigned group's ID.          |
| Type          | string        | The ticket type.                  |
| Created At    | string        | When the ticket was created.      |
| Updated At    | string        | When the ticket was last updated. |
| Due By        | string        | The ticket due date.              |
| Conversations | object\_array | Ticket conversations and notes.   |

#### Get Tickets by Filter

Get tickets from Freshservice matching filter criteria.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field   | Type    | Required | Description                                |
| ------- | ------- | -------- | ------------------------------------------ |
| Filters | object  | Yes      | Filters to search tickets by field values. |
| Limit   | integer | No       | Maximum number of tickets to return.       |

**Outputs**

| Field       | Type          | Description                          |
| ----------- | ------------- | ------------------------------------ |
| Tickets     | object\_array | List of tickets matching the filter. |
| Total Count | integer       | Total number of tickets returned.    |

#### Update Ticket

Update a ticket in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field                   | Type             | Required | Description                                                                      |
| ----------------------- | ---------------- | -------- | -------------------------------------------------------------------------------- |
| Ticket ID               | string           | Yes      | The ticket ID.                                                                   |
| Subject                 | string           | No       | Updated subject of the ticket.                                                   |
| Description             | string           | No       | Updated HTML content/body of the ticket.                                         |
| Status                  | select (integer) | No       | Updated status of the ticket. Available values: Open, Pending, Resolved, Closed. |
| Priority                | select (integer) | No       | Updated priority of the ticket. Available values: Low, Medium, High, Urgent.     |
| Urgency                 | select (integer) | No       | Updated urgency of the ticket. Available values: Low, Medium, High.              |
| Impact                  | select (integer) | No       | Updated impact of the ticket. Available values: Low, Medium, High.               |
| Category                | string           | No       | Updated category of the ticket.                                                  |
| Tags                    | string\_array    | No       | Updated tags for the ticket.                                                     |
| Bypass Mandatory Fields | boolean          | No       | Toggle to bypass mandatory field validation when updating. Default: false.       |

**Outputs**

| Field        | Type    | Description                       |
| ------------ | ------- | --------------------------------- |
| Ticket ID    | integer | The updated ticket's ID.          |
| Subject      | string  | The ticket subject.               |
| Description  | string  | The ticket description.           |
| Status       | integer | The ticket status.                |
| Priority     | integer | The ticket priority.              |
| Requester ID | integer | The requester's ID.               |
| Group ID     | integer | The assigned group's ID.          |
| Type         | string  | The ticket type.                  |
| Created At   | string  | When the ticket was created.      |
| Updated At   | string  | When the ticket was last updated. |
| Due By       | string  | The ticket due date.              |

#### Delete Ticket

Delete a ticket from Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field     | Type   | Required | Description    |
| --------- | ------ | -------- | -------------- |
| Ticket ID | string | Yes      | The ticket ID. |

**Outputs**

| Field      | Type   | Description                   |
| ---------- | ------ | ----------------------------- |
| Deleted ID | string | The ID of the deleted ticket. |

#### Create Ticket Note

Add a note to a ticket in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field        | Type    | Required | Description                                                                     |
| ------------ | ------- | -------- | ------------------------------------------------------------------------------- |
| Ticket ID    | string  | Yes      | The ticket ID.                                                                  |
| Note Body    | string  | Yes      | The content of the note (supports HTML).                                        |
| Private Note | boolean | No       | Toggle to make this a private note (agents only) or public note. Default: true. |

**Outputs**

| Field           | Type    | Description                             |
| --------------- | ------- | --------------------------------------- |
| Conversation ID | integer | The conversation ID.                    |
| Body (HTML)     | string  | The conversation body.                  |
| Body (Text)     | string  | The conversation body as plain text.    |
| Private         | boolean | Whether this is a private note.         |
| User ID         | integer | The user who created this conversation. |
| Created At      | string  | When the conversation was created.      |
| Updated At      | string  | When the conversation was last updated. |

#### Reply to Ticket

Send a reply to a ticket in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field      | Type   | Required | Description                               |
| ---------- | ------ | -------- | ----------------------------------------- |
| Ticket ID  | string | Yes      | The ticket ID.                            |
| Reply Body | string | Yes      | The content of the reply (supports HTML). |

**Outputs**

| Field           | Type    | Description                             |
| --------------- | ------- | --------------------------------------- |
| Conversation ID | integer | The conversation ID.                    |
| Body (HTML)     | string  | The conversation body.                  |
| Body (Text)     | string  | The conversation body as plain text.    |
| Private         | boolean | Whether this is a private note.         |
| User ID         | integer | The user who created this conversation. |
| Created At      | string  | When the conversation was created.      |
| Updated At      | string  | When the conversation was last updated. |

#### List Agents

List agents in Freshservice.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field | Type    | Required | Description                         |
| ----- | ------- | -------- | ----------------------------------- |
| Limit | integer | No       | Maximum number of agents to return. |

**Outputs**

| Field       | Type          | Description                      |
| ----------- | ------------- | -------------------------------- |
| Agents      | object\_array | List of agents.                  |
| Total Count | integer       | Total number of agents returned. |

#### Get Agent

Get a specific agent from Freshservice by ID.

**Required permissions:** `freshservice.tickets.manage`.

**Inputs**

| Field    | Type   | Required | Description   |
| -------- | ------ | -------- | ------------- |
| Agent ID | string | Yes      | The agent ID. |

**Outputs**

| Field               | Type    | Description                      |
| ------------------- | ------- | -------------------------------- |
| Agent ID            | integer | The agent ID.                    |
| First Name          | string  | The agent's first name.          |
| Last Name           | string  | The agent's last name.           |
| Job Title           | string  | The agent's job title.           |
| Work Phone Number   | string  | The agent's work phone number.   |
| Mobile Phone Number | string  | The agent's mobile phone number. |
| Email               | string  | The agent's email.               |
| Active              | boolean | Whether the agent is active.     |
| Created At          | string  | When the agent was created.      |
| Updated At          | string  | When the agent was last updated. |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/freshservice.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
