Freshworks MCP Server

The Create Ticket API is used to create a new ticket in the system. It requires several parameters in the request body, including the ticket name, assigned user ID, creator user ID, due date, description, ticket type ID, account ID, project ID, group ID, contact IDs, priority, source, tags, and additional metadata. The request must include headers for content type and authorization. Upon successful creation, the API returns the ticket ID in the response body.

The Update Ticket API allows users to update an existing ticket by providing the ticket ID and other relevant details. The request includes headers for content type and authorization, a path parameter for the ticket ID, and a body containing details such as the ticket name, assigned user ID, creator ID, due date, description, ticket type ID, account ID, project ID, group ID, contact IDs, priority, source, tags, status, and additional metadata. The response returns the updated ticket ID.

This API retrieves a list of all users in the system. It supports pagination through the 'cursor' query parameter. The response includes pagination details and a list of users, each with attributes such as ID, name, email ID, phone number, active status, and associated group IDs.

This API retrieves a list of all accounts or companies in the system. It supports pagination through the use of a 'cursor' query parameter. The response includes pagination information with 'next' and 'previous' cursors, and a list of accounts, each containing details such as 'id', 'name', 'createdAt', 'website', and 'industry'. No headers, path parameters, or request body are required for this API.

The Get List of Tickets API retrieves a list of all tickets in the system with optional filters. The API supports filtering by account ID, contact ID, assigned user ID, status, tag, ticket type, creation date range, update date range, and due date range. Pagination is supported through a cursor parameter. The response includes pagination information and a list of tickets, each with details such as ID, creation and update timestamps, name, assigned user, creator, due date, status, description, ticket type, associated account, project, group, contact IDs, priority, source, URL, tags, and custom fields.

This API retrieves the details of a particular account or company in the system. It requires the account ID as a path parameter. The response includes the account ID, name, creation date, website, and industry.

This API retrieves the list of all comments, conversations, or notes along with attachments for a specific ticket. The request requires the 'ticketId' as a query parameter to identify the ticket for which comments are to be fetched. An optional 'cursor' parameter can be used for pagination. The response includes pagination details and an array of comments, each with details such as the comment ID, creation date, body, HTML formatted body, visibility status, author information, and any associated attachments.

This API retrieves the details of a particular user in the system. It requires a 'userId' as a query parameter to identify the user. The response includes the user's ID, name, email ID, phone number, active status, and the list of group IDs the user is part of.

This API retrieves a list of all contacts or people in the system. It accepts optional query parameters such as 'accountId' to filter contacts by a specific account and 'cursor' for pagination. The response includes pagination details and an array of contact objects, each containing information like contact ID, name, creation date, email address, phone number, and associated account ID.

The Get Ticket By ID API retrieves the details of a specific ticket using its ID. The request requires the ticket ID as a path parameter. The response includes comprehensive details about the ticket such as its creation and update timestamps, name, assigned user, creator, due date, status, description, type, associated account, project, group, contact IDs, priority, source, URL, tags, and any custom fields.

This API retrieves a list of all tags that can be applied to a ticket in the system. It supports pagination through the use of a 'cursor' query parameter. The response includes pagination details and an array of tags, each with an ID and name.

This API retrieves a list of all groups or teams in the system. It supports pagination through a 'cursor' query parameter. The response includes pagination information and details of each group, such as the group ID, name, description, whether it is public, and the list of user IDs belonging to the group.

This API retrieves the details of a particular contact or person in the system using their contact ID. The request requires the contact ID as a path parameter. The response includes the contact's ID, name, creation date, email address, phone number, and the account ID to which the contact belongs.

This API is used to add comments, conversations, or notes along with attachments for a particular ticket. The request body requires a 'ticketId' to specify the ticket for which the comment is being added. Optional fields include 'body' for the comment text, 'isPublic' to indicate if the comment is public, 'author' to specify the author of the comment, 'attachments' for any files to be attached, and 'metadata' for any additional fields. The response returns the 'id' of the newly created comment.