Connectors

Customer Support & Success

Freshservice

IT service management: tickets, assets, changes, problems, and approvals
Freshservice API referenceAPI checked August 17, 2026
Signs in with
Connection fields
Runs on
Cloud or On-Prem Worker
Operations
552
Ready-made triggers
0

Connect Freshservice

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Freshservice and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
DomainRequiredThe subdomain in {domain}.freshservice.com.
Api KeyOptionalSecretFreshservice API key; encoded as Basic API-key-as-username with dummy password x.
Access TokenOptionalSecretFreshservice OAuth 2.0 access token for operations whose official reference publishes a scope.

Use it in a flow

  1. Open a flow, open the node library and search for Freshservice.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from Freshservice without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Freshservice can send webhooks, a Webhook trigger receives them at its own URL.

Operations

552 operations in 53 groups. Each one is a step you can add to a flow.

Agent Groups5
Create a GroupcreateAGroupPOSTNote: 1.
Delete a GroupdeleteAGroupDELETENote: 1.
List all GroupsviewAllGroupGETNote: Freshservice/Freshservice for Business Teams: List of agent groups belonging to a particular workspace can be retrieved by passing query parameter as workspace id=[number].
Update a GroupupdateAGroupPUTNote: 1.
View a GroupviewAGroupGETView a Group Freshservice Freshservice for Business Teams Freshservice for MSPs
Agent Roles2
List all RolesviewAllRoleGETList all Roles Freshservice Freshservice for Business Teams Freshservice for MSPs
View a RoleviewARoleGETView a Role Freshservice Freshservice for Business Teams Freshservice for MSPs
Agents11
Convert To RequesterconvertAnAgentToRequesterPUTThis operation allows you to convert a particular agent into a requester.
Create an AgentcreateAnAgentPOSTThis operation allows you to create a new agent.
Deactivate an AgentdeleteAnAgentDELETEThis operation allows you to deactivate a particular agent.
Filter AgentsfilterAgentsGETUse Agent attributes to filter your list.
Forget an AgentforgetAnAgentDELETEThis operation allows you to permanently delete a agent and the tickets that they requested.
List all Agent FieldslistAllAgentFieldsGETThis operation allows you to view all the built-in and custom fields for agents in your Freshservice account.
List all AgentslistAgentsGETThis operation allows you to view information about all agents in the account.
Reactivate an AgentreactivateAnAgentPUTThis operation allows you to reactivate a particular deactivated agent.
Update an AgentupdateAnAgentPUTThis operation allows you to modify the profile of a particular agent.
User Assignment HistoryuserAssignmentHistoryAgentsGETThis operation retrieves the asset assignment history of a specific agent in Freshservice.
View an AgentviewAnAgentGETThis operation allows you to view information about a particular agent.
Alert Management13
Acknowledge an alertacknowledgeAlertPUTThis operation allows the user to acknowledge the alert.
Create an Alert NotecreateAlertNotePOSTThis operation allows the user to create an alert note.
Delete an AlertdeleteAlertDELETEThis operation allows the user to delete the alert.
Delete an alert notedeleteAlertNoteDELETEThis operation allows the user to update an alert note.
Resolve an alertresolveAlertPUTThis operation allows the user to resolve the alert.
Suppress an alertsuppressAlertPUTThis operation allows the user to suppress the alert.
Unsuppress an alertunsuppressAlertPUTThis operation allows the user to unsuppress the alert.
Update an alert noteupdateAlertNotePUTThis operation allows the user to update an alert note.
View all Alert LogsviewAlertLogsGETThis operation allows the user to view all the alert logs for a particular alert.
View all alert notesviewAlertNotesGETThis operation allows the user to view all alert notes.
View an alertviewAlertGETThis operation allows the user to view the alert properties.
View an alert noteviewAlertNoteGETThis operation allows the user to view an alert note.
View Multiple Alerts using FiltersfilterAlertsGETThis operation allows the user to view the bulk alerts and their properties using different filters.
Announcements5
Create an AnnouncementcreateAnAnnouncementPOSTCreate an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs
Delete an AnnouncementdeleteAnAnnouncementDELETEDelete an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs
Edit an AnnouncementeditAnAnnouncementPUTEdit an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs
List all AnnouncementslistAllAnnouncementsGETList all Announcements Freshservice Freshservice for Business Teams Freshservice for MSPs
View an AnnouncementviewAnAnnouncementGETView an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs
Approvals1
List all ApprovalslistAllApprovalsGETThe approval properties can be used to filter approvals from ticket and change module and get a list of approval requests matching the specified filters.
Asset Types6
Create an Asset TypecreateAnAssetTypePOSTThis operation allows you to create an asset type in Freshservice.
Delete an Asset TypedeleteAnAssetTypeDELETEThis operation allows you to delete a particular asset type.
List all Asset TypeslistAllAssetTypesGETThis operation allows you to view information about all the asset types in the account.
List all Fields of an Asset TypelistAssetTypeFieldsGETThis operation allows you to view information about all the fields in a particular asset type in the account.
Update an Asset TypeupdateAnAssetTypePUTThis operation allows you to update an existing asset type.
View an Asset TypeviewAnAssetTypeGETThis operation allows you to view information about a particular asset type
Assets22
Asset Assignment HistoryassetAssignmentHistoryGETThis operation retrieves the user assignment history for a specific asset in Freshservice.
Create a ComponentcreateAComponentPOSTThis operation allows you to create a component for an asset.
Create an AssetcreateAnAssetPOSTThis operation allows you to create a new asset in Freshservice.
Create Relationships in bulkcreateRelationshipsPOSTThis operation allows you to create new relationships in bulk.
Delete an AssetdeleteAnAssetDELETEThis operation allows you to delete a particular asset.
Delete an Asset PermanentlydeleteForeverAnAssetPUTThis operation allows you to permanently delete an asset which cannot be restored later.
Delete Relationships in bulkdeleteRelationshipsDELETEDelete relationships in your Freshservice account in bulk.
Filter AssetsfilterAssetsGETUse asset attributes to filter your list.
List all Asset ComponentslistAllAssetComponentsGETThis operation allows you to view information about all the components of an asset in the account.
List all associated ContractslistContractsOfAnAssetGETThis operation allows you to get a list of all the contracts that an asset has been associated to.
List all Associated RequestslistAllAssetRequestsGETThis operation allows you to view a list of all the requests associated to the asset in the account.
List all Relationship TypeslistRelationshipTypesGETLists all the relationship types in your Freshservice account.
List all Relationships for an AssetlistRelationshipsOfAnAssetGETLists all the relationships of a particular asset.
List all Relationships in the AccountlistRelationshipsGETLists all the relationships in your Freshservice account.
Move an AssetmoveAnAssetPUTThis API moves an asset to a different workspace, while also allowing the assigned group and agent to be modified.
Restore an AssetrestoreAnAssetPUTThis operation allows you to restore a deleted asset.
Search AssetssearchAssetsGETUse asset attributes to search from your list.
Update a ComponentupdateAComponentPUTThis operation allows you to update an existing component for an asset.
Update an AssetupdateAnAssetPUTThis operation allows you to update an existing asset.
View a RelationshipviewARelationshipGETThis operation allows you to view a particular relationship in your Freshservice account.
View an AssetviewAnAssetGETThis operation allows you to view a particular asset.
View List of AssetslistAssetsGETLists all the assets in your Freshservice account.
Assets Itam7
Create an assetcreateAnAssetForFreshserviceItamPOSTThis API helps you create an asset.
Create or update custom fieldcreateOrUpdateCustomFieldOfAssetsForFreshserviceItamPUTThis API helps you create or update custom fields data for assets.
Delete an assetdeleteAnAssetForFreshserviceItamDELETEThis API helps you delete an asset record by its unique identifier.
Update an assetupdateAnAssetForFreshserviceItamPUTThis API helps you update an existing asset by using either the identifier or asset name.
Update an asset by IDupdateAnAssetByIdForFreshserviceItamPUTThis API helps you update an existing asset by using the identifier of the asset.
View an assetviewAnAssetForFreshserviceItamGETThis API helps you retrieve an asset record by its unique identifier.
View list of assetsviewAllAssetsForFreshserviceItamGETThis API helps you retrieve a list of existing assets.
Attachment2
Download AttachmentdownloadAttachmentGETThis API helps you to download attachments of Ticket, Problem, Change, Release, Solution Article and Asset.
Download Purchase order and Contracts AttachmentdownloadPurchaseAndContractAttachmentGETThis API helps you to download attachments of Purchase order and Contract.
Audit Logs1
Audit Log ExportexportAuditLogsPOSTThis API helps to export the changes made inside your service desk.
Business Hours2
View a Business Hours ConfigurationviewABusinessHourGETRetrieve the Business Hours Configuration with the given ID from Freshservice/Freshservice for Business Teams
View List of Business Hours ConfigurationslistAllBusinessHoursGETRetrieve a list of all business hours configurations in Freshservice/Freshservice for Business Teams.
Cabs5
Create a CABcreateACabPOSTNote: A maximum of 100 user IDs can be be passed to add members at a time.
Delete a CABdeleteACabDELETENote: 1.
List all CABsviewAllCabsGETNote: All the below requests are paginated to return only 30 CABS per page as default.
Update a CABupdateACabPATCHNote: A maximum of 100 user IDs can be be passed to add members or remove members at a time.
View a CABviewACabGETUse 'include' to embed additional details in the response.
Canned Responses5
List all Canned Responses In a FolderlistAllCannedResponseInFolderGETThis API lists all the Canned Response Folders that are present in the folder.
Show a Canned ResponseshowCannedResponseGETThis API show a specific Canned Response
Show a Canned Response FoldershowCannedResponseFolderGETThis API show a specific Canned Response
View List of Canned Response FolderslistAllCannedResponseFoldersGETThis API lists all the canned response folders that are present in the account.
View List of Canned ResponseslistAllCannedResponsesGETThis API lists all the canned responses that are present in the folder.
Changes33
Cancel a Change ApprovalcancelChangeApprovalPUTCancel the Approval for a Change Note: This API supports the changing of an approval status to "cancelled" state only.
Cancel Approval Group In A Change RequestcancelChangeApprovalGroupsPUTCancel Approval Group In A Change Request
Create a ChangecreateChangePOSTCreate a new Change request in Freshservice Note: You can associate a maintenance window with a change using the Create a Change API by providing the maintenance window ID.
Create a Change with filescreateChangeMultipartPOSTCreate a new Change request in Freshservice Note: You can associate a maintenance window with a change using the Create a Change API by providing the maintenance window ID.
Create a NotecreateChangeNotePOSTCreate a new note on a change request in freshservice.
Create a TaskcreateChangeTaskPOSTCreate a new task on a change request in freshservice.
Create a Time EntrycreateTimeEntriesPOSTCreate a new time entry on a change request in freshservice.
Create an Approval Group for ChangescreateChangeApprovalGroupsPOSTCreate an Approval Group for a Change Note: "email content" is an optional parameter for sending approval.
Delete a ChangedeleteAChangeDELETEDelete the Change request with the given ID from Freshservice.
Delete a NotedeleteAChangeNoteDELETEDelete the note on a Change request with the given ID from Freshservice.
Delete a TaskdeleteAChangeTaskDELETEDelete the task on a Change request with the given ID from Freshservice Note: Deleted tasks are permanently lost.
Delete a Time EntrydeleteATimeEntryDELETEDelete the time entry on a Change request with the given ID from Freshservice.
List all Approval Groups within a ChangelistAllChangeApprovalGroupsGETList all Approval Groups in a Change.
List all Change ApprovalslistAllChangeApprovalsGETRetrieve all approvals in a Change with the given ID from Freshservice.
List all Change FieldsviewAllChangeFieldsGETRetrieve all the Fields that constitute the Change Object Note: By default, only global fields and fields from the primary workspace will be returned for accounts with workspaces.
List all Time EntriesviewAllTimeEntriesGETRetrieve the time entries on a Change request with the given ID from Freshservice.
Move a ChangemoveAChangePUTThis API moves a change to a different workspace, while also allowing the assigned group and agent to be modified.
Send Reminder for a Change ApprovalresendReminderChangeApprovalPUTResends a reminder for a specific Approval raised for the Change
Update a ChangeupdateChangePriorityPUTUpdate an existing Change request in Freshservice Note: The workspace id attribute cannot be updated through the Update operation.
Update a Change with filesupdateChangePriorityMultipartPUTUpdate an existing Change request in Freshservice Note: The workspace id attribute cannot be updated through the Update operation.
Update a NoteupdateAChangeNotePUTUpdate an existing note on an existing Change request in Freshservice.
Update a TaskupdateAChangeTaskPUTUpdate an existing task on an existing Change request in Freshservice
Update a Time EntryupdateTimeEntryPUTUpdate an existing time entry on an existing Change request in Freshservice.
Update approval chain rule for a changeupdateApprovalChainRuleChangePUTUpdate the approval chain rule for a change
Update Approval Group In A Change RequestupdateChangeApprovalGroupsPUTUpdate Approval Group In A Change Request Note: "email content" is an optional parameter for sending approval.
View a ChangeviewAChangeGETUse 'include' to embed additional details in the response.
View a Change ApprovalviewAChangeApprovalGETRetrieve an approval on a Change with the given ID from Freshservice
View a NoteviewAChangeNoteGETRetrieve a note on a Change request with the given ID from Freshservice.
View a TaskviewAChangeTaskGETRetrieve a task on a Change request with the given ID from Freshservice
View a Time EntryviewATimeEntryGETRetrieve a time entry on a Change request with the given ID from Freshservice.
View all NotesviewAllChangeNotesGETRetrieve a list of all notes on a Change request with the given ID from Freshservice.
View all TasksviewAllChangeTasksGETRetrieve the tasks on a Change request with the given ID from Freshservice.
View List of ChangeslistChangesGETUse filters to view changes based on the criteria that you choose.
Cloud Infrastructure4
Create or update custom fieldupdateCustomFieldOfCloudInfrastructurePUTThis API helps you create or update custom fields data for the cloud account.
Delete cloud detailsdeleteCloudInfrastructureDELETEThis API helps you delete a cloud account ID and all attached cloud resources.
Update cloud detailsupdateCloudInfrastructurePOSTThis API helps you update a cloud infrastructure for AWS discovery.
View cloud detailsviewAllCloudInfrastructureGETThis API helps you retrieve a list of cloud resources for AWS discovery.
Collaborate7
Retrieve emails related to a ticketretrieveEmailsGETRetrieve emails associated to a major incident by ticket ID Note: This API is triggered only for tickettype = Major Incident.
Retrieve specific emails using IDretrieveEmailsWithIdGETRetrieve emails associated to a major incident by ticket ID Note: This API is triggered only for tickettype = Major Incident.
Retrieve zoom meetings related to a ticketretrieveZoomMeetingsGETRetrieve past or ongoing Zoom meetings for a ticket.
Retrieve zoom meetings related to a ticket with IDretrieveZoomMeetingsWithIdGETRetrieve past or ongoing Zoom meetings for a ticket with the ID.
Trigger a new zoom meetingtriggerNewMeetingPOSTTrigger a Zoom meeting to collaborate on the ticket.
Trigger an Email with attachment for a Major IncidenttriggerEmailWithAttachmentPOSTSend an email related to a ticket or incident with attachments.
Trigger email for a major incidenttriggerEmailPOSTNotify major incidents via email.
Contracts14
Approve a ContractapproveContractPUTThis operation allows you to approve a contract in the account.
Create a ContractcreateAContractPOSTThis operation allows you to create a new contract in Freshservice.
Create a Contract with associated assetscreateContractWithAssociatedAssetsPOSTThis API lets you create a new Contract with associated Assets (CIs) in your service desk.
Create a Contract with attachmentcreateContractWithAttachmentPOSTNote: 1.
List all associated assets of a contractlistAllAssociatedAssetsGETThis operation allows you to view information about all the associated asset of a contract.
List all attachments of a contractlistAllAttachmentsGETThis operation allows you to view information about all the attachments of a contract.
List all contract typeslistAllContractTypesGETThis operation allows you to view a list of all contract type.
List all contractslistAllContractsGETThis operation allows you to view a list of all contracts.
List all fields of a contract typelistAllContractTypeFieldsGETThis operation allows you to view all fields of a contract type.
Move a ContractmoveAContractPUTThis API moves a contract to a different workspace, while also allowing the visibility group to be modified.
Reject a ContractrejectContractPUTThis operation allows you to reject a contract in the account.
Submit a contract for approvalsubmitContractForApprovalPUTThis operation allows you to submit a contract for approval in the account.
Update a ContractupdateAContractPUTNote: The workspace id attribute cannot be updated through the Update operation.
View a contractviewAContractGETThis operation allows you to view a particular contract.
Conversations8
Create a NoteaddNotePOSTNote: By default, any note that you add will be private.
Create a ReplyreplyTicketPOSTNote: 1.
Create a Reply with filesreplyTicketMultipartPOSTNote: 1.
Delete a ConversationdeleteAConversationsDELETEDelete a Conversation Freshservice Freshservice for Business Teams Freshservice for MSPs
Delete a Conversation AttachmentdeleteAConversationAttachmentDELETEThis API helps you delete an attachment from a conversation.
List all Conversations of a TicketlistConversationsGETThis API helps you List All Conversations of a Ticket.
Update a ConversationupdateAConversationsPUTNote: Only public & private notes can be edited.
Update a Conversation with filesupdateAConversationsMultipartPUTNote: Only public & private notes can be edited.
Custom Objects6
Create new Custom Object RecordcreateCustomObjectRecordPOSTThis API creates a new record in a Custom object.
Delete Custom Object RecorddeleteCustomObjectRecordDELETEThis API deletes an existing record in a Custom object.
List all records of a Custom ObjectlistAllCustomObjectRecordsGETThis API lists all the records present in a given Custom object.
Show a Custom ObjectshowCustomObjectGETThis API gives you the details of a given Custom object like field names, options for dropdown fields etc.
Update Custom Object RecordputCustomObjectRecordPUTThis API updates the value of the given fields of a record in a Custom object.
View List of Custom ObjectslistAllCustomObjectsGETThis API lists all the Custom objects that are present in the account.
Delegation4
Create a delegationcreateDelegationPOSTUse this API to create a new delegation period for a specific user.
Delete a delegationdeleteDelegationDELETEUse this API to delete an existing delegation.
Update a delegationupdateDelegationPUTUse this API to update the delegation information such as duration or notes of an existing delegation.
View a delegationviewDelegationGETUse this API to view the current delegation details associated with a user.
Departments7
Create a DepartmentcreateADepartmentPOSTNote: You cannot create departments for workspace id=1 (Global).
Delete a DepartmentdeleteADepartmentDELETEDelete the Department (or Company in MSP Mode) with the given ID from Freshservice.
Filter DepartmentsfilterDepartmentsGETUse Departments (or Companies in MSP Mode) attributes to filter your list.
List all Department FieldslistAllDepartmentFieldsGETRetrieve the Department Fields (or Company Fields in MSP Mode) from Freshservice.
List all DepartmentslistAllDepartmentsGETNote: 1.
Update a DepartmentupdateADepartmentPUTUpdate an existing Department (or Company in MSP Mode) in Freshservice/Freshservice for Business Teams.
View a DepartmentviewADepartmentGETRetrieve the Department (or Company in MSP Mode) with the given ID from Freshservice
Devices6
Create a devicecreateDevicePOSTThis API helps you create or update devices.
Create or update custom fieldupdateCustomFieldOfDevicesPUTThis API helps you create or update custom fields data for devices.The device id parameter is required to identify the device Note: Freshservice IT Asset Management is available only for...
Delete a devicedeleteDeviceDELETEThis API helps you delete a device record by its unique identifier.
Update a deviceupdateDevicePUTThis API helps you update a device record by ID.
View a deviceviewADeviceGETThis API helps you retrieve a device record by its unique identifier.
View list of all devicesviewAllDevicesGETThis API helps you retrieve information about all devices.
Employee Offboarding5
Create an Offboarding RequestcreateOffboardingRequestPOSTThis API helps you to create a new Offboarding Request in your service desk.
View all Offboarding RequestslistAllOffboardingRequestsGETThis API lets you view all the Offboarding Requests in your service desk.
View an Offboarding RequestviewOffboardingRequestGETThis API lets you retrieve and view a specific Offboarding Request in your service desk.
View Offboarding Form FieldsoffboardingFormGETThis API lets you view all the fields in the Initiator’s Offboarding form.
View Offboarding TicketsviewOffboardingTicketsGETThis API lets you retrieve and view the Offboarding Tickets associated with an Offboarding Request.
Employee Onboarding5
Create an Onboarding RequestcreateOnboardingRequestPOSTThis API helps you to create a new Onboarding Request in your service desk.
View all Onboarding RequestslistAllOnboardingRequestsGETThis API lets you view all the Onboarding Requests in your service desk.
View an Onboarding RequestviewOnboardingRequestGETThis API lets you retrieve and view a specific Onboarding Request in your service desk.
View Onboarding Form FieldsonboardingFormGETThis API lets you view all the fields in the Initiator’s Onboarding form.
View Onboarding TicketsviewOnboardingTicketsGETThis API lets you retrieve and view the Onboarding Tickets associated with an Onboarding Request.
Journeys10
Cancel a Journey RequestcancelJourneyRequestPUTThis API cancels the specified Journey Request from Freshservice.
Create a Journey RequestcreateJourneyRequestPOSTThis API allows you to initiate a new Journey Request in Freshservice/Freshservice for Business Teams.
Delete a Journey RequestdeleteJourneyRequestDELETEThis API deletes the specified Journey Request from Freshservice.
Filter Journey RequestsfilterJourneyRequestsPOSTThis API retrieves a list of Journey Requests that match the specified filter criteria.
Update a Journey RequestupdateJourneyRequestPATCHThis API updates the details of an existing Journey Request in Freshservice.
View a Journey RequestviewJourneyRequestGETNote: Only users with View Journey Requests privilege can access the following API.
View Journey Initiator Config Form FieldsjourneyInitiatorConfigFormGETThis API retrieves all fields from the Initiator Form of a Journey configuration.
View Journey Request ActivitiesviewJourneyRequestActivitiesGETThis API lists all activities associated with a specific Journey Request across its various phases,identified by the Journey Request ID.
View List of Journey RequestsviewAllJourneyRequestsGETThis API returns a filtered list of Journey Requests, excluding deleted entries by default.
View List of Published Journeys ConfigsjourneyConfigsGETNote: 1.
Lifecycle Events4
Create or update lifecycle eventsupdateLifecycleEventsPUTThis API helps you create or update lifecycle events for devices and assets.
Delete a lifecycle eventdeleteLifecycleEventDELETEThis API helps you delete a lifecycle event record by its unique identifier.
View a lifecycle eventviewALifecycleEventGETThis API helps you retrieve a lifecycle event record by its unique identifier.
View list of all lifecycle eventsviewAllLifecycleEventsGETThis API helps you retrieve a list of existing lifecycle events.
Locations6
Create a LocationcreateALocationPOSTThis operation allows you to create a new location in Freshservice/Freshservice for Business Teams.
Delete a LocationdeleteALocationDELETEThis operation allows you to delete a particular location.
Filter LocationsfilterLocationsGETYou can filter locations by their Name.
List all LocationslistAllLocationsGETThis operation allows you to view information about all the locations in the account.
Update a LocationupdateALocationPUTThis operation allows you to update an existing location.
View a LocationviewALocationGETThis operation allows you to view information about a particular location.
Oncall Management34
Create a schedulecreateSchedulePOSTThis operation allows you to create an on-call schedule for an agent group Note: Only users with "Manage On-call schedules" privilege can access the following API.
Create a shiftcreateShiftPOSTThis operation lets you create a new shift within your on-call schedule Note: Only users with "Manage On-call schedules" privilege can access the following API.
Create an escalation policycreateEpPOSTThis operation lets you create a new escalation policy within an existing on-call schedule Note: Only users with "Manage On-call schedules" privilege can access the API.
Create/Update/Delete an overrideoverridePUTThis operation lets you create, update, delete an override as part of an existing shift so that another agent will be on-call instead of the one originally configured Note: Only users...
Delete a scheduledeleteScheduleDELETEThis operation allows you to delete n on-call schedules in your workspace by its ID Note: Only users with "Manage On-call schedules" privilege can access the API.
Delete a shiftdeleteShiftDELETEThis operation allows you to delete shifts in your on-call schedule by using their ids Note: Only users with "Manage On-call schedules" privilege can access the following API.
Delete an escalation policydeleteEpDELETEThis operation lets you delete an escalation policy Note: Only users with "Manage On-call schedules" privilege can access the API.
Export oncall calendar events as an .ical file for a scheduleexportIcalCalendarEventsScheduleGETThis operation enables you to export all on-call calendar events for a schedule within the specified date range.
Export oncall calendar events as an .ical file for a shiftexportIcalCalendarEventsShiftGETThis operation enables you to export all on-call calendar events for a shift within the specified date range.
Export oncall calendar events as an .ical file for a userexportIcalCalendarEventsUserGETThis operation enables you to export all on-call calendar events for a user within the specified date range.
Export oncall calendar events as an .ical file of a schedule for a userexportIcalCalendarEventsScheduleUserGETThis operation enables you to export all on-call calendar events for a schedule for a specific user within the specified date range.
Export oncall calendar events as an .ical file of a shift for a userexportIcalCalendarEventsShiftUserGETThis operation enables you to export all on-call calendar events for a shift within a schedule for a specific user within the specified date range.
Export oncall calendar events for a scheduleexportCalendarEventsScheduleGETThis operation enables you to export all on-call events for a schedule as a webcal link.
Export oncall calendar events for a shiftexportCalendarEventsShiftGETThis operation enables you to export all on-call events for a shift within a schedule as a webcal link.
Export oncall calendar events for a userexportCalendarEventsUserGETThis operation enables you to export all on-call events for a user as a webcal link.
Export oncall calendar events of a schedule for a userexportCalendarEventsScheduleUserGETThis operation enables you to export all on-call events for a schedule for a specific user as a webcal link.
Export oncall calendar events of a shift for a userexportCalendarEventsShiftUserGETThis operation enables you to export all on-call events for a shift within a schedule for a specific user as a webcal link.
Filter schedulesfilterSchedulesGETThis operation allows you to get list of all on-call schedules in your workspace whose schedule names include the search query (scheduleName).
Reorder an escalation policyreorderEpPUTThis operation lets you re-order the escalation policies (EP) within an on-call schedule.
Update a scheduleeditSchedulePUTThis operation allows you to update an existing on-call schedule Note: Only users with "Manage On-call schedules" privilege can access the following API.
Update a shifteditShiftPUTThis operation lets you update an existing shift within your on-call schedule Note: Only users with "Manage On-call schedules" privilege can access the following API.
Update an escalation policyeditEpPUTThis operation lets you update an escalation policy within an existing on-call schedule Note: Only users with "View On-call schedules" or "Manage On-call schedules" privilege can access...
View a scheduleviewAScheduleGETThis operation allows you to fetch details about all on-call schedules in your workspace by ID Note: Only users with "View On-call schedules" or "Manage On-call schedules" privilege can...
View a shiftviewAShiftGETThis operation allows you to fetch details about relevant shifts in your on-call schedule by using their ids Note: Only users with "View On-call schedules" or "Manage On-call schedules"...
View all escalation policiesviewAllEpGETThis operation lets you get details about all the escalation policies in an on-call schedule Note: Only users with "View On-call schedules" or "Manage On-call schedules" privilege can...
View all schedulesviewAllSchedulesGETThis operation allows you to fetch details about all on-call schedules in your workspace Note: Only users with "View On-call schedules" or "Manage On-call schedules" privilege can access...
View all shiftsviewAllShiftsGETThis operation allows you to fetch details about all shifts in your on-call schedule Note: Only users with "View On-call schedules" or "Manage On-call schedules" privilege can access the...
View an escalation policyviewAEpGETThis operation lets you get details about particular escalation policies in an on-call schedule by its id Note: Only users with "View On-call schedules" or "Manage On-call schedules"...
View oncall calendar events for a scheduleviewCalendarEventsScheduleGETThis operations enables you to get information about all on-call events in an on-call schedule during a fixed duration Note: Only users with "View On-call schedules", "Manage On-call...
View oncall calendar events for a shiftviewCalendarEventsShiftGETThis operation enables you to get information about all on-call events in an shift during a fixed duration Note: Only users with "View On-call schedules", "Manage On-call schedules" or...
View oncall calendar events for a userviewCalendarEventsUserGETThis operations enables you to get information about all on-call events for a user has during a fixed duration Note: Only users with "View On-call schedules", "Manage On-call schedules"...
View oncall calendar events of a schedule for a userviewCalendarEventsScheduleUserGETThis operation enables you to get information about all on-call events in an shift for a user Note: Only users with "View On-call schedules", "Manage On-call schedules" or "View Tickets"...
View oncall calendar events of a shift for a userviewCalendarEventsShiftUserGETThis operation enables you to get information about all on-call events in an shift for a user Note: Only users with "View On-call schedules", "Manage On-call schedules" or "View Tickets"...
View who is oncallviewWhoIsOncallGETThis operation enables you to find out who’s on call right now for a given on-call schedule using its id Note: Only users with "View On-call schedules", "Manage On-call schedules" or...
Physical Subtypes4
Create or update physical subtypescreatePhysicalSubtypePOSTThis API helps you create or update physical subtypes.
Delete a physical subtypedeletePhysicalSubtypeDELETEThis API helps you delete a physical subtype record by its unique identifier.
View a physical subtypeviewAPhysicalSubtypeGETThis API helps you retrieve a physical subtype record by its unique identifier.
View list of physical subtypesviewAllPhysicalSubtypesGETThis API helps you retrieve all device physical subtypes.
Post Incident Reports7
Create new templates for post-incident reportscreateNewTemplatePOSTDesign a new post-incident report template.
Delete an existing post-incident report templatedeletePirTemplateDELETERemove an existing PIR template.
Enable template for post-incident reportsenablePirTemplatePUTEnable post-incident report templates.
Export the post-incident report templateexportPirTemplatePOSTExport templates of post-incident reports as a PDF or DOCX file.
Get all post-incident report templatesgetAllPirTemplatesGETRetrieve all PIR templates in a workspace.
Get post-incident report templates by IDgetPirTemplatesByIdGETRetrieve a specific PIR template using its ID (PIR-ID)
Set template as primary for post-incident reportsmarkPrimaryPirTemplatePUTSet a template as primary for post-incident reports.
Problems24
Create a notecreateProblemNotePOSTCreate a new note on a problem request in freshservice.
Create a ProblemcreateProblemPOSTCreate a new problem request in Freshservice Note: 1.
Create a Problem with filescreateProblemMultipartPOSTCreate a new problem request in Freshservice Note: 1.
Create a TaskcreateProblemTaskPOSTCreate a new task on a problem in freshservice
Create a Time EntrycreateProblemTimeEntriesPOSTCreate a new time entry on a problem request in freshservice.
Delete a notedeleteAProblemNoteDELETEDelete the note on a Problem request with the given ID from Freshservice.
Delete a ProblemdeleteAProblemDELETEDelete the Problem with the given ID from Freshservice
Delete a TaskdeleteAProblemTaskDELETEDelete the task on a Problem with the given ID from Freshservice Note: Deleted tasks are permanently lost.
Delete a Time EntrydeleteAProblemTimeEntryDELETEDelete the time entry on a Problem request with the given ID from Freshservice.
List all Problem FieldsviewAllProblemFieldsGETRetrieve all the Fields that constitute the Problem Object Note: By default, only global fields and fields from the primary workspace will be returned for accounts with workspaces.
List all Time EntriesviewAllProblemTimeEntriesGETRetrieve the time entries on a Problems request with the given ID from Freshservice.
Move a ProblemmoveAProblemPUTThis API moves a problem to a different workspace, while also allowing the assigned group and agent to be modified.
Restore a ProblemrestoreAProblemPUT
Update a noteupdateAProblemNotePUTUpdate an existing note on an existing Problem request in Freshservice.
Update a ProblemupdateProblemPriorityPUTUpdate an existing Problem in Freshservice Note: The workspace id attribute cannot be updated through the Update operation.
Update a TaskupdateAProblemTaskPUTUpdate an existing task on an existing Problem in Freshservice
Update a Time EntryupdateProblemTimeEntryPUTUpdate an existing time entry on an existing Problem request in Freshservice.
View a noteviewAProblemNoteGETRetrieve a note on a Problem request with the given ID from Freshservice.
View a ProblemviewAProblemGETRetrieve the problem with the given ID from Freshservice
View a TaskviewAProblemTaskGETRetrieve a task on a Problem with the given ID from Freshservice
View a Time EntryviewAProblemTimeEntryGETRetrieve a time entry on a Problem request with the given ID from Freshservice.
View all notesviewAllProblemNotesGETRetrieve a list of all notes on a Problem request with the given ID from Freshservice.
View all TasksviewAllProblemTasksGETRetrieve the tasks on a Problem with the given ID from Freshservice
View List of ProblemslistProblemsGETRetrieve a list of all Problems in Freshservice Note: If a workspace id is not specified as a URL parameter, only problems from the primary workspace will be included in the response.
Products5
Create a ProductcreateAProductPOSTThis operation allows you to create a new product in Freshservice.
Delete a ProductdeleteAProductDELETEThis operation allows you to delete a particular product.
List all ProductsviewAllProductsGETThis operation allows you to view information about all products in the account.
Update a ProductupdateAProductPUTThis operation allows you to update an existing product.
View a ProductviewAProductGETThis operation allows you to view a particular product.
Project Tasks5
Create a Project TaskcreateAProjectTaskPOSTCreate a Project Task Freshservice Freshservice for Business Teams
Delete a Project TaskdeleteAProjectTaskDELETEThis API helps you delete a project task.
List all Project TasksviewAllProjectTasksGETList all Project Tasks Freshservice Freshservice for Business Teams
Update a Project TaskupdateAProjectTaskPUTUpdate a Project Task Freshservice Freshservice for Business Teams
View a Project TaskviewAProjectTaskGETView a Project Task Freshservice Freshservice for Business Teams
Project Tasks Newgen26
Create a Project TaskcreateAProjectTaskNewgenPOSTThis API lets you create a project task.
Create a Project Task with filescreateAProjectTaskNewgenMultipartPOSTThis API lets you create a project task.
Create AssociationscreateProjectTaskAssociationsPOSTThis API allows you to associate a task with specific Tickets, Problems, Changes or Assets.
Create NotecreateNoteTaskNewgenPOSTThis API allows you to add a note to a task.
Create Note with filescreateNoteTaskNewgenMultipartPOSTThis API allows you to add a note to a task.
Delete a Project TaskdeleteAProjectTaskNewgenDELETEThis API helps you delete a project task.
Delete AssociationdeleteProjectTaskAssociationDELETEThis API allows you to delete an association of a project task.
Delete Attachment of a NotedeleteAttachmentNoteTaskNewgenDELETEThis API allows you to delete an attachment of a note.
Delete Attachment of a TaskdeleteAttachmentTaskNewgenDELETEThis API allows you to delete an attachment of a task.
Delete NotedeleteNoteTaskNewgenDELETEThis API allows you to delete a note.
Filter all Project TasksfilterAllProjectTasksNewgenGETGet a list of tasks matching the specified task fields.
List all Project TasksviewAllProjectTasksNewgenGETList all Project Tasks Freshservice Freshservice for Business Teams
Update a Project TaskupdateAProjectTaskNewgenPUTThis API lets you update a project task Note: 1.
Update a Project Task with filesupdateAProjectTaskNewgenMultipartPUTThis API lets you update a project task Note: 1.
Update NoteupdateNoteTaskNewgenPUTThis API allows you to update a note.
Update Note with filesupdateNoteTaskNewgenMultipartPUTThis API allows you to update a note.
View a Project TaskviewAProjectTaskNewgenGETThis API lets you view the details of a project task
View AssociationsviewProjectTaskAssociationsGETThis API allows you to view all associations of a project task by module.
View NotesviewNotesTaskNewgenGETThis API allows you to view all task notes.
View Project MembershipsviewProjectMembershipsGETThis API lists all the members that are present in a project.
View Project SprintsviewProjectSprintsGETThis API lists all the sprints that have been created in a project.
View Project Task PrioritiesviewProjectTaskPrioritiesGETThis API lists all the priority levels that have been created in a project.
View Project Task StatusesviewProjectTaskStatusesGETThis API lists all the task statuses that have been defined in a project.
View Project Task Type FieldsviewProjectTaskTypeFieldsGETThis API lets you list the fields of a specifc task type from your project.
View Project Task TypesviewProjectTaskTypesGETThis API lists all the task types that are present in a project.
View Project VersionsviewProjectVersionsGETThis API lists all the versions that have been created in a project.
Projects7
Archive a ProjectarchiveAProjectPOSTThis API helps you archive a project.
Create a ProjectcreateAProjectPOSTCreate a Project Freshservice Freshservice for Business Teams
Delete a ProjectdeleteAProjectDELETEThis API helps you permanently delete a project.
List all ProjectsviewAllProjectsGETList all Projects Freshservice Freshservice for Business Teams
Restore a ProjectrestoreAProjectPOSTYou can restore an archived project using this API.
Update a ProjectupdateAProjectPUTUpdate a Project Freshservice Freshservice for Business Teams
View a ProjectviewAProjectGETView a Project Freshservice Freshservice for Business Teams
Projects Newgen16
Add MembersaddProjectMembersPOSTThis API allows you to add one or more members to a project.
Archive a ProjectarchiveAProjectNewgenPOSTNote: Archived projects are not permanently lost.
Create a ProjectcreateAProjectNewgenPOSTThis API helps you create a new project in your service desk Note: 1.
Create a Project with filescreateAProjectNewgenMultipartPOSTThis API helps you create a new project in your service desk Note: 1.
Create AssociationscreateProjectAssociationsPOSTThis API allows you to associate a Project with specific Tickets, Problems, Changes or Assets.
Delete a ProjectdeleteAProjectNewgenDELETEThis API lets you permanently delete a project.
Delete AssociationdeleteProjectAssociationDELETEThis API allows you to delete an association of a project.
Delete Attachment of a ProjectdeleteAttachmentProjectNewgenDELETEThis API allows you to delete an attachment of a project.
List all ProjectsviewAllProjectsNewgenGETList all Projects Freshservice Freshservice for Business Teams
Restore a ProjectrestoreAProjectNewgenPOSTYou can restore an archived project using this API.
Update a ProjectupdateAProjectNewgenPUTThis API lets you update the properties of a project.
Update a Project with filesupdateAProjectNewgenMultipartPUTThis API lets you update the properties of a project.
View a ProjectviewAProjectNewgenGETThis API lets you view the details of a project.
View AssociationsviewProjectAssociationsGETThis API allows you to delete an association of a project.
View Project FieldsviewProjectFieldsGETView Project Fields Freshservice Freshservice for Business Teams
View Project TemplatesviewProjectTemplatesGETView Project Templates Freshservice Freshservice for Business Teams
Purchase Order6
Create a new Purchase OrdercreateANewPurchaseOrderPOSTThis operation allows you to Create a new Purchase Order in Freshservice.
Delete a Purchase OrderdeleteAPurchaseOrderDELETEThis operation allows you to delete a particular purchase order.
List all Purchase OrderslistAllPurchaseOrdersGETThis operation allows you to view information about all the purchase orders in Freshservice.
Move a Purchase OrdermoveAPurchaseOrderPUTThis API moves a purchase order to a different workspace.
Update a Purchase OrderupdateAPurchaseOrderPUTThis operation allows you to update an existing purchase order.
View a Purchase OrderviewAPurchaseOrderGETThis operation allows you to view a particular purchase order.
Releases25
Create a notecreateReleaseNotePOSTCreate a new note on a release request in freshservice.
Create a ReleasecreateReleasePOSTCreate a new Release request in Freshservice Note: 1.
Create a Release with filescreateReleaseMultipartPOSTCreate a new Release request in Freshservice Note: 1.
Create a TaskcreateReleaseTaskPOSTCreate a new task on a release in freshservice
Create a Time EntrycreateReleaseTimeEntriesPOSTCreate a new time entry on a release request in freshservice.
Delete a notedeleteAReleaseNoteDELETEDelete the note on a Release request with the given ID from Freshservice.
Delete a ReleasedeleteAReleaseDELETEDelete the Release with the given ID from Freshservice
Delete a TaskdeleteAReleaseTaskDELETEDelete the task on a Release with the given ID from Freshservice Note: Deleted tasks are permanently lost.
Delete a Time EntrydeleteAReleaseTimeEntryDELETEDelete the time entry on a Release request with the given ID from Freshservice.
Filter ReleasesfilterReleasesGETThis API helps you to view all the releases in your service desk.
List all Time EntriesviewAllReleaseTimeEntriesGETRetrieve the time entries on a Release request with the given ID from Freshservice.
Move a ReleasemoveAReleasePUTThis API moves a release to a different workspace, while also allowing the assigned group and agent to be modified.
Restore a ReleaserestoreAReleasePUT
Update a noteupdateAReleaseNotePUTUpdate an existing note on an existing Release request in Freshservice.
Update a ReleaseupdateReleasePriorityPUTUpdate an existing Release in Freshservice Note: The workspace id attribute cannot be updated through the Update operation.
Update a TaskupdateAReleaseTaskPUTUpdate an existing task on an existing Release in Freshservice
Update a Time EntryupdateReleaseTimeEntryPUTUpdate an existing time entry on an existing Release request in Freshservice.
View a noteviewAReleaseNoteGETRetrieve a note on a Release request with the given ID from Freshservice.
View a ReleaseviewAReleaseGETRetrieve the Release with the given ID from Freshservice
View a TaskviewAReleaseTaskGETRetrieve a task on a Release with the given ID from Freshservice
View a Time EntryviewAReleaseTimeEntryGETRetrieve a time entry on a Release request with the given ID from Freshservice.
View all notesviewAllReleaseNotesGETRetrieve a list of all notes on a Release request with the given ID from Freshservice.
View all Release FieldsviewAllReleaseFieldsGETRetrieve all the Fields that constitute the Release Object Note: By default, only global fields and fields from the primary workspace will be returned for accounts with workspaces.
View all TasksviewAllReleaseTasksGETRetrieve the tasks on a Release with the given ID from Freshservice
View list of ReleasesviewAllReleaseGETRetrieve a list of all Releases in Freshservice Note: If a workspace id is not specified as a URL parameter, only releases from the primary workspace will be included in the response.
Requester Groups8
Add Requester to Requester/Contact GroupaddMemberToRequesterGroupPOSTNote: 1.Requesters/contacts can be added only to manual requester groups.
Create a Requester Group/Contact GroupcreateARequesterGroupPOSTNote: Only groups of type “manual” can be created through this API.
Delete a Requester Group/Contact GroupdeleteARequesterGroupDELETENote: 1.
Delete Requester/Contact from Requester/Contact GroupdeleteMemberFromRequesterGroupDELETENote: 1.Requesters/Contacts can be removed only from manual requester groups.
List All Requester Groups/Contact GroupsviewAllRequesterGroupGETNote: Groups of both types (“manual”/”rule based”) can be listed through this API.
List Requester/Contact Group MemberslistMembersOfRequesterGroupGETList Requester/Contact Group Members Freshservice Freshservice for Business Teams Freshservice for MSPs
Update a Requester Group/Contact GroupupdateARequesterGroupPUTNote: Only groups of type “manual” can be updated through this API.
View a Requester Group/Contact GroupviewARequesterGroupGETNote: Groups of both types (“manual”/”rule based”) can be viewed through this API.
Requesters12
Convert To AgentconvertToAgentPUTConvert a requester to an occasional agent with SD Agent role and no group memberships.
Create a Requester/ContactcreateARequesterPOSTThis operation allows you to create a new requester.
Deactivate a Requester/ContactdeactivateARequesterDELETEThis operation allows you to deactivate a requester.
Filter Requester/ContactfilterRequestersGETUse Requester/Contacts attributes to filter your list.
Forget a Requester/ContactforgetARequesterDELETEThis operation allows you to permanently delete a requester and the tickets that they requested.
List All Requester/Contact FieldslistAllRequesterFieldsGETThis operation allows you to view all the built-in and custom fields for requesters in your Freshservice account.
List All Requesters/ContactslistRequestersGETThis operation returns a list of all requester/contact in the account.
Merge Requesters/ContactsmergeRequestersPUTMerge secondary requesters into a primary requester.
Reactivate a Requester/ContactreactivateARequesterPUTThis operation allows you to reactivate a particular deactivated requester.
Update a Requester/ContactupdateARequesterPUTThis operation allows you to modify the profile of a particular requester.
User Assignment HistoryuserAssignmentHistoryGETThis operation retrieves the assignment history of a specific user in Freshservice.
View a Requester/ContactviewARequesterGETThis operation allows you to view information about a requester or contact.
Resource Relationships2
Delete a cloud resource relationshipdeleteCloudResourceRelationshipDELETEThis API helps you delete a cloud resource relationship ID and attached resource relationships.
View list of all cloud resource relationshipsviewAllCloudResourceRelationshipsGETThis API helps you retrieve a list of cloud resource relationships for AWS.
Resources5
Create or update custom fieldupdateCustomFieldOfResourcesPUTThis API helps you create or update custom fields data for cloud resources.
Delete a cloud resourcedeleteCloudResourceDELETEThis API helps you delete a cloud resource by ID and all attached resources.
Update a cloud resourceupdateCloudResourcePOSTThis API helps you update a cloud resource for AWS discovery.
View a cloud resourceviewACloudResourceGETThis API helps you retrieve details of a particular cloud resources for AWS discovery.
View list of all cloud resourcesviewAllCloudResourcesGETThis API helps you retrieve a list of cloud resources for AWS discovery.
Service Catalog16
Archive shared fieldsarchiveSharedFieldsPOSTArchive a shared field using this API
Create a Service Catalog Item with agent group visibilitiescreateServiceCatalogItemWithAgentGroupVisibilitiesPOSTCreate a Service Catalog Item with agent group visibilities Freshservice Freshservice for MSPs
Create a Service Catalog Item With Shared FieldscreateServiceCatalogItemWithSharedFieldsPOSTCreate a Service Catalog Item With Shared Fields Freshservice Freshservice for MSPs
Create a shared fieldcreateSharedFieldsPOSTCreate shared fields.
Create Service Catalog itemcreateServiceCatalogItemPOSTThis operation allows you to create a new service item in Freshservice/Freshservice for Business Teams.
Delete a Service Catalog ItemdeleteAServiceItemDELETEThis API allows you to delete a service item.
Delete shared fieldsdeleteSharedFieldsDELETEDelete shared fields with this API.
List all shared fields based on searchsharedFieldsGETRetrieve a list of all shared fields.
Retrieve shared fields dataretrieveSharedFieldsDataGETRetrieve shared field data for individual fields.
Search Service ItemssearchServiceItemGETSearch for service items from the service catalog for a given search term.
Unarchive shared fieldsunarchiveSharedFieldsPOSTThis API unarchives a shared field.
Update a Service Catalog ItemupdateServiceItemPUTUpdate an existing service item.
Update shared fieldsupdateSharedFieldsPUTUpdates shared fields with relevant field values.
View a Service ItemviewServiceItemGETThis API allows you to view the details of a service item.
View List of Service CategorieslistAllServiceCategoriesGETThis api lists all service categories in your Freshservice service desk Note: By default, only service categories from the primary workspace will be returned for accounts on the Employee...
View List of Service ItemslistAllServiceItemsGETThis API lists all service items in your Freshservice service desk.
Sla Policies1
View List of SLAslistAllSlaGETThis API helps to view all time entries of a particular ticket.
Software17
Add a device to a SoftwarecreateAnInstallationsPOSTThis operation allows you to add a new device to a Software.
Add Users to a Software in bulkbulkCreateUsersPOSTThis operation allows you to add Users to a Software in bulk.
Create a SoftwarecreateASoftwarePOSTThis operation allows you to create a new software in Freshservice.
Delete a SoftwaredeleteASoftwareDELETEThis operation allows you to delete a particular software.
Delete multiple SoftwaredeleteMultipleSoftwareDELETEThis operation allows you to delete multiple software.
List all installations of a SoftwarelistInstallationsGETThis operation allows you to view the list of all the devices where the Software is installed in.
List all LicenseslistAllLicensesGETThis operation allows you to list all licenses of a software.
List all Relationships for a SoftwarelistRelationshipsOfASoftwareGETLists all the relationships of a particular software.
List all SoftwarelistAllSoftwareGETThis operation allows you to list all software.
List all Users of a SoftwarelistUsersGETThis operation allows you to view the list of users using a particular Software.
Move a SoftwaremoveASoftwarePUTThis API moves a software to a different workspace.
Remove devices from a Software in bulkbulkDeleteInstallationsDELETEThis operation allows you to remove devices from a Software in bulk.
Remove Users from a Software in bulkbulkDeleteUsersDELETEThis operation allows you to remove Users from a Software in bulk.
Update a SoftwareupdateASoftwarePUTThis operation allows you to update an existing software.
Update Users of a Software in bulkbulkUpdateUsersPUTThis operation allows you to update Users of a Software in bulk.
View a SoftwareviewASoftwareGETThis operation allows you to view a particular software.
View a Software UserviewUserGETThis operation allows you to view a particular Software User.
Solution Article14
Bulk Restore Solution ArticlesbulkRestoreSolutionArticlePUTRestore multiple articles from Trash.
Create Article from External URLcreateExternalArticlePOSTTo write a new solution external article in a category, use this API.
Create Article With AttachmentcreateSolutionArticleWithAttachmentPOSTTo write a new solution article with attachments in a category, use this API.
Create Secondary Language ArticlecreateSecondaryLanguageArticlePOSTTo create a secondary language article and link it to a primary language article, use this API
Create Solution ArticlecreateSolutionArticlePOSTTo write a new solution article in a category, use this API.
Delete Solution ArticledeleteSolutionArticleDELETETo delete a solution article, use this API.
Permanently Delete Solution ArticledeleteForeverSolutionArticleDELETEPermanently delete an article from Trash.
Publish Solution ArticlepublishSolutionArticlePUTTo publish an solution article, use this API.
Restore Solution ArticlerestoreSolutionArticlePUTRestore an article from Trash.
Search Solution ArticlessearchSolutionArticleGETSearch for articles from the knowledge base for a given search term.
Send Article to ApprovalsendArticleToApprovalPUTTo send article approval for the review, use this API.
Update Solution ArticleupdateSolutionArticlePUTTo update an article, use this API.
View List of Solution ArticleviewAllSolutionArticleGETTo view all the articles, use this API.
View Solution ArticleviewSolutionArticleGETIf there is a specific article which you wish to view, use this API.
Solution Category7
Create Solution CategorycreateSolutionCategoryPOSTUse this API to create a new category of solutions.
Delete Solution CategorydeleteSolutionCategoryDELETETo delete a solution category, use this API.
Permanently Delete Solution CategorydeleteForeverSolutionCategoryDELETEPermanently delete a category from Trash.
Restore Solution CategoryrestoreSolutionCategoryPUTRestore a category from Trash.
Update Solution CategoryupdateSolutionCategoryPUTUse this API to update solution categories.
View List of Solution CategoriesviewAllSolutionCategoryGETThis API lets you view all the categories in a forum.
View Solution CategoryviewSolutionCategoryGETTo view the category available in your service desk, use this
Solution Folder9
Create Solution FoldercreateSolutionFolderPOSTUse this API to create a new folder in your solutions.
Create Solution Folder with ApprovalcreateSolutionFolderWithApprovalPOSTUse this API to create a new folder with approval settings in your solutions.
Delete Solution FolderdeleteSolutionFolderDELETETo delete a solution folder, use this API.
Permanently Delete Solution FolderdeleteForeverSolutionFolderDELETEPermanently delete a folder from Trash.
Restore Solution FolderrestoreSolutionFolderPUTRestore a folder from Trash.
Update Solution FolderupdateSolutionFolderPUTNote: The following parameters can be only updated for Freshservice for MSPs.
View List of Solution FolderviewAllSolutionFolderGETThis API lets you view all the folders in a forum for specific category.
View Solution FolderviewSolutionFolderGETTo view all folders present in a category, use this API.
View Solution Sub FoldersviewSolutionSubFoldersGETTo view all sub-folders present in a folder, use this API.
Status Page39
Create a maintenance from a changecreateMaintenanceFromChangePOSTThis operation allows the user to create a maintenance from a change.
Create a maintenance from a maintenance windowcreateMaintenanceFromMaintenanceWindowPOSTThis operation allows the user to create a maintenance from a maintenance window.
Create a maintenance update from a changecreateMaintenanceUpdateFromChangePOSTThis operation allows the user to create an update to maintenance from a change.
Create a maintenance update from a maintenance windowcreateMaintenanceUpdateFromMaintenanceWindowPOSTThis operation allows the user to create an update to maintenance from a maintenance window.
Create a subscribercreateSubscriberPOSTUse this API to create a new subscriber for a status page.
Create an incidentcreateIncidentPOSTThis operation allows the user to create an incident.
Create incident updatecreateIncidentUpdatePOSTThis operation allows the user to post an update to an incident.
Delete a maintenance from a changedeleteMaintenanceFromChangeDELETEThis operation allows the user to delete the maintenance associated to the change.
Delete a maintenance from a maintenance windowdeleteMaintenanceFromMaintenanceWindowDELETEThis operation allows the user to delete the maintenance associated to the maintenance window.
Delete a maintenance update from a changedeleteMaintenanceUpdateFromChangeDELETEThis operation allows the user to delete the maintenance update associated to the change.
Delete a maintenance update from a maintenance windowdeleteMaintenanceUpdateFromMaintenanceWindowDELETEThis operation allows the user to delete the maintenance update associated to the maintenance window.
Delete a subscriberdeleteSubscriberDELETEUse this API to delete a subscriber from the specified status page.
Delete an incidentdeleteIncidentDELETEThis operation allows the user to delete the incident.
Delete an incident updatedeleteIncidentUpdateDELETEThis operation allows the user to delete the update of the incident Note: Only users with "Delete Status page incidents" privilege can access this API.
Edit an incident updateupdateIncidentUpdatePUTThis operation allows the user to edit an update posted to an incident.
Identify publishable services from a changeidentifyPublishableServicesChangeGETUse this API to identify publishable services from a change.
Identify publishable services from a maintenance windowidentifyPublishableServicesMaintenanceGETUse this API to identify publishable services from a maintenances window.
Identify publishable services from a ticketidentifyPublishableServicesTicketGETUse this API to identify publishable services from a ticket.
List all incident statuseslistAllIncidentStatusesGETThis operation allows the user to view the list of incident statuses.
List all incidentsviewIncidentsGETThis operation allows the user to view the list of incidents.
List all maintenance statuseslistAllMaintenanceStatusesGETThis operation allows the user to view the list of maintenance statuses.
List all maintenance updates from a changeviewMaintenanceUpdateFromChangeGETThis operation allows the user to view the list of updates posted to a maintenance via a change.
List all maintenance updates from a maintenance windowviewMaintenanceUpdateFromMaintenanceWindowGETThis operation allows the user to view the list of updates posted to a maintenance via a maintenance window.
List all maintenancesviewMaintenancesGETThis operation allows the user to view the list of maintenances.
List all service componentsviewServiceComponentsGETThis operation allows the user to view list of service components.
List all status pagesviewStatusPagesGETThis operation allows the user to view all the status pages.
List all subscriberslistAllSubscribersGETUse this API to view all subscribers associated with a specific status page.
List all updates for an incidentviewIncidentUpdatesGETThis operation allows the user to view the list of incident updates.
Update a maintenance from a changeupdateMaintenanceFromChangePUTThis operation allows the user to update a maintenance from a change.
Update a maintenance from a maintenance windowupdateMaintenanceFromMaintenanceWindowPUTThis operation allows the user to update a maintenance from a maintenance window.
Update a maintenance update from a changeupdateMaintenanceUpdateFromChangePUTThis operation allows the user to edit an update posted to a maintenance from a change.
Update a maintenance update from a maintenance windowupdateMaintenanceUpdateFromMaintenanceWindowPUTThis operation allows the user to update a maintenance update from the maintenance window.
Update a subscriberupdateSubscriberPUTUse this API to update the service subscription preferences for an existing subscriber.
Update an incidentupdateIncidentPUTThis operation allows the user to update an incident.
View a maintenance from a changeviewMaintenanceFromChangeGETThis operation allows the user to view the maintenance associated to the change.
View a maintenance from a maintenance windowviewMaintenanceFromMaintenanceWindowGETThis operation allows the user to view the maintenance associated to the change.
View a service componentviewServiceComponentGETThis operation allows the user to view a service component.
View a subscriberviewASubscriberGETUse this API to view details of a subscriber associated with a specific status page.
View an incidentviewIncidentGETThis operation allows the user to view an incident.
Tickets45
Add Catalog Item to Existing Service RequestaddCatalogItemToExistingSrPOSTThis API helps you add a new catalog item to an existing service request.
Cancel an approvalcancelATicketApprovalPUTCancel an existing approval on a Service Request Note: You can only update the approval status of a request to "cancelled" state through this API.
Cancel Approval Group In A Service RequestcancelApprovalGroupsPUTCancel Approval Group in a Service Request
Create a Child Service RequestcreateChildServiceRequestPOSTThis API helps you to create a new child ticket on an existing ticket Note 1: Association of child Service Request to a deleted or a spammed ticket is not allowed.
Create a Child TicketcreateChildTicketPOSTThis API lets you to create a new child ticket on an existing ticket Note: 1.
Create a Service RequestcreateServiceRequestPOSTThis API helps you create a service request Note 1: The service requested will be created with the requester specified in “email” attribute.
Create a Service Request with filescreateServiceRequestMultipartPOSTThis API helps you create a service request Note 1: The service requested will be created with the requester specified in “email” attribute.
Create a SourcecreateCustomTicketSourcePOSTThis API helps you create a new Ticket Source.
Create a TaskcreateTicketTaskPOSTCreate a new task on a ticket request in freshservice
Create a TicketcreateTicketPOSTThis API helps you to create a new ticket in your service desk.
Create a Ticket with filescreateTicketMultipartPOSTThis API helps you to create a new ticket in your service desk.
Create a Time EntrycreateTicketTimeEntryPOSTThis API helps to create a Time Entry.
Create Approval Groups for a Service RequestcreateApprovalGroupsPOSTCreate an Approval Group for a Service Request Note: "email content" is an optional parameter for sending approval.
CSAT ResponseviewCsatResponseGETRetrieve a csat response of a Ticket with the given ID from Freshservice/Freshservice for Business Teams.
Delete a TaskdeleteATicketTaskDELETEDelete the task on a Ticket with the given ID from Freshservice/Freshservice for Business Teams.
Delete a TicketdeleteTicketDELETEThis API helps you delete a ticket.
Delete a Ticket AttachmentdeleteATicketAttachmentDELETEThis API helps you delete an attachment from a ticket.
Delete a Time EntrydeleteTicketTimeEntryDELETEThis API can be used to delete an existing Time Entry.
Demote an incident from a major incidentdemoteIncidentFromMajorPUTDemote a major incident back to a normal incident.
Filter TicketsfilterTicketsGETCustom ticket fields that you have created in your account can also be used to filter through the tickets and get a list of tickets matching the specified ticket fields.
Get Ticket ActivitygetTicketActivitiesGETRetrieve recent ticket activity for any ticket using ticket ID.
List all Ticket Approval GroupslistAllTicketApprovalGroupsGETList all Approval Groups in the Service Request.
List all Ticket ApprovalslistAllTicketApprovalsGETRetrieve all approvals on a Service Request with the given ID from Freshservice/Freshservice for Business Teams.
List all Ticket FieldsviewAllTicketFieldsGETRetrieve all the Fields that constitute the Ticket Object Note: By default, only global fields and fields from the primary workspace will be returned for accounts with workspaces.
List all Time Entries of a TicketlistAllTicketTimeEntriesGETThis API helps to view all time entries of a particular ticket.
Move a TicketmoveATicketPUTFreshservice/Freshservice for Business Teams - This API allows you to move a ticket between workspaces while also modifying the assigned group and agent.
Promote an incident to a major incidentpromoteIncidentToMajorPUTPromote an existing incident into a major incident.
Request Approval for a Service RequestcreateTicketApprovalPOSTSend a Service Request for approval Note: 1.
Restore a TicketrestoreATicketPUT
Send Reminder for an ApprovalresendReminderTicketApprovalPUTResends a reminder for a specific Approval raised for the ticket
Update a TaskupdateATicketTaskPUTUpdate an existing task on an existing Ticket in Freshservice
Update a TicketupdateTicketPUTThis API lets you make changes to the parameters of a ticket from updating statuses to changing ticket type.
Update a Ticket with filesupdateTicketMultipartPUTThis API lets you make changes to the parameters of a ticket from updating statuses to changing ticket type.
Update a Time EntryupdateTicketTimeEntryPUTThis API can be used to update/modify existing time entry.
Update approval chain rule for a service requestupdateServiceRequestApprovalChainRulePUTUpdate chain rule for the approval groups in the service request.
Update Approval Group In A Service RequestupdateApprovalGroupsPUTUpdate Approval Group In A Service Request Note: "email content" is an optional parameter for sending approval.
Update Requested Items of a Service RequestupdateReqItemsOfSrPUTThis api helps you to update the requested items attached to a service request Note: 1.
Update Requested Items of a Service Request with filesupdateReqItemsOfSrMultipartPUTThis api helps you to update the requested items attached to a service request Note: 1.
View a TaskviewATicketTaskGETRetrieve a task on a Ticket with the given ID from Freshservice
View a TicketgetTicketGETUse 'include' to embed additional details in the response.
View a Time EntryviewTicketTimeEntryGETThis API call helps to list a particular Time Entry.
View all TasksviewAllTicketTasksGETRetrieve the tasks on a Ticket with the given ID from Freshservice.
View an ApprovalviewATicketApprovalGETRetrieve an approval on a Service Request with the given ID from Freshservice
View List of TicketslistTicketsGETUse filters to view only specific tickets (those which match the criteria that you choose).
View Requested Items of a Service RequestviewReqItemsOfSrGETThis api helps you to view requested items attached to a service request
Vendors5
Create a VendorcreateAVendorPOSTThis operation allows you to create a vendor.
Delete a VendordeleteAVendorDELETEThis operation allows you to delete a vendor.
List all VendorsviewAllVendorsGETThis operation allows you to view information about all vendors in the account.
Update a VendorupdateAVendorPUTThis operation allows you to update a vendor.
View a VendorviewAVendorGETThis operation allows you to view a particular vendor.
Workspaces7
Create ClientcreateClientPOSTYou cannot create a client with workspace id = 1 (Global), 2 (Default Client) and 3 (MSP Client) as these are system generated.
Delete a ClientdeleteAClientDELETECannot delete client with id = 1,2 and 3 as these are reserved for internal purposes
Filter ClientsfilterClientsGETNote: 1.
List All Client FieldslistAllClientFieldsGETRetrieve all the Fields that constitute the Client Object.
List All Workspaces / ClientsviewAllWorkspacesGETRetrieves information about all the workspaces created in the account
Update a ClientupdateAClientPUTYou cannot update clients with workspace id = 1 (Global), 2 (Default Client).
View a Workspace / ClientviewAWorkspaceGETRetrieves information about a particular workspace in the account