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
- In Neblex open Connect › Connections and click New Connection.
- Search for Freshservice and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| DomainRequired | The subdomain in {domain}.freshservice.com. |
| Api KeyOptionalSecret | Freshservice API key; encoded as Basic API-key-as-username with dummy password x. |
| Access TokenOptionalSecret | Freshservice OAuth 2.0 access token for operations whose official reference publishes a scope. |
Use it in a flow
- Open a flow, open the node library and search for Freshservice.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- 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 GroupcreateAGroup | POST | Note: 1. |
Delete a GroupdeleteAGroup | DELETE | Note: 1. |
List all GroupsviewAllGroup | GET | Note: 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 GroupupdateAGroup | PUT | Note: 1. |
View a GroupviewAGroup | GET | View a Group Freshservice Freshservice for Business Teams Freshservice for MSPs |
Agent Roles2
List all RolesviewAllRole | GET | List all Roles Freshservice Freshservice for Business Teams Freshservice for MSPs |
View a RoleviewARole | GET | View a Role Freshservice Freshservice for Business Teams Freshservice for MSPs |
Agents11
Convert To RequesterconvertAnAgentToRequester | PUT | This operation allows you to convert a particular agent into a requester. |
Create an AgentcreateAnAgent | POST | This operation allows you to create a new agent. |
Deactivate an AgentdeleteAnAgent | DELETE | This operation allows you to deactivate a particular agent. |
Filter AgentsfilterAgents | GET | Use Agent attributes to filter your list. |
Forget an AgentforgetAnAgent | DELETE | This operation allows you to permanently delete a agent and the tickets that they requested. |
List all Agent FieldslistAllAgentFields | GET | This operation allows you to view all the built-in and custom fields for agents in your Freshservice account. |
List all AgentslistAgents | GET | This operation allows you to view information about all agents in the account. |
Reactivate an AgentreactivateAnAgent | PUT | This operation allows you to reactivate a particular deactivated agent. |
Update an AgentupdateAnAgent | PUT | This operation allows you to modify the profile of a particular agent. |
User Assignment HistoryuserAssignmentHistoryAgents | GET | This operation retrieves the asset assignment history of a specific agent in Freshservice. |
View an AgentviewAnAgent | GET | This operation allows you to view information about a particular agent. |
Alert Management13
Acknowledge an alertacknowledgeAlert | PUT | This operation allows the user to acknowledge the alert. |
Create an Alert NotecreateAlertNote | POST | This operation allows the user to create an alert note. |
Delete an AlertdeleteAlert | DELETE | This operation allows the user to delete the alert. |
Delete an alert notedeleteAlertNote | DELETE | This operation allows the user to update an alert note. |
Resolve an alertresolveAlert | PUT | This operation allows the user to resolve the alert. |
Suppress an alertsuppressAlert | PUT | This operation allows the user to suppress the alert. |
Unsuppress an alertunsuppressAlert | PUT | This operation allows the user to unsuppress the alert. |
Update an alert noteupdateAlertNote | PUT | This operation allows the user to update an alert note. |
View all Alert LogsviewAlertLogs | GET | This operation allows the user to view all the alert logs for a particular alert. |
View all alert notesviewAlertNotes | GET | This operation allows the user to view all alert notes. |
View an alertviewAlert | GET | This operation allows the user to view the alert properties. |
View an alert noteviewAlertNote | GET | This operation allows the user to view an alert note. |
View Multiple Alerts using FiltersfilterAlerts | GET | This operation allows the user to view the bulk alerts and their properties using different filters. |
Announcements5
Create an AnnouncementcreateAnAnnouncement | POST | Create an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs |
Delete an AnnouncementdeleteAnAnnouncement | DELETE | Delete an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs |
Edit an AnnouncementeditAnAnnouncement | PUT | Edit an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs |
List all AnnouncementslistAllAnnouncements | GET | List all Announcements Freshservice Freshservice for Business Teams Freshservice for MSPs |
View an AnnouncementviewAnAnnouncement | GET | View an Announcement Freshservice Freshservice for Business Teams Freshservice for MSPs |
Approvals1
List all ApprovalslistAllApprovals | GET | The 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 TypecreateAnAssetType | POST | This operation allows you to create an asset type in Freshservice. |
Delete an Asset TypedeleteAnAssetType | DELETE | This operation allows you to delete a particular asset type. |
List all Asset TypeslistAllAssetTypes | GET | This operation allows you to view information about all the asset types in the account. |
List all Fields of an Asset TypelistAssetTypeFields | GET | This operation allows you to view information about all the fields in a particular asset type in the account. |
Update an Asset TypeupdateAnAssetType | PUT | This operation allows you to update an existing asset type. |
View an Asset TypeviewAnAssetType | GET | This operation allows you to view information about a particular asset type |
Assets22
Asset Assignment HistoryassetAssignmentHistory | GET | This operation retrieves the user assignment history for a specific asset in Freshservice. |
Create a ComponentcreateAComponent | POST | This operation allows you to create a component for an asset. |
Create an AssetcreateAnAsset | POST | This operation allows you to create a new asset in Freshservice. |
Create Relationships in bulkcreateRelationships | POST | This operation allows you to create new relationships in bulk. |
Delete an AssetdeleteAnAsset | DELETE | This operation allows you to delete a particular asset. |
Delete an Asset PermanentlydeleteForeverAnAsset | PUT | This operation allows you to permanently delete an asset which cannot be restored later. |
Delete Relationships in bulkdeleteRelationships | DELETE | Delete relationships in your Freshservice account in bulk. |
Filter AssetsfilterAssets | GET | Use asset attributes to filter your list. |
List all Asset ComponentslistAllAssetComponents | GET | This operation allows you to view information about all the components of an asset in the account. |
List all associated ContractslistContractsOfAnAsset | GET | This operation allows you to get a list of all the contracts that an asset has been associated to. |
List all Associated RequestslistAllAssetRequests | GET | This operation allows you to view a list of all the requests associated to the asset in the account. |
List all Relationship TypeslistRelationshipTypes | GET | Lists all the relationship types in your Freshservice account. |
List all Relationships for an AssetlistRelationshipsOfAnAsset | GET | Lists all the relationships of a particular asset. |
List all Relationships in the AccountlistRelationships | GET | Lists all the relationships in your Freshservice account. |
Move an AssetmoveAnAsset | PUT | This API moves an asset to a different workspace, while also allowing the assigned group and agent to be modified. |
Restore an AssetrestoreAnAsset | PUT | This operation allows you to restore a deleted asset. |
Search AssetssearchAssets | GET | Use asset attributes to search from your list. |
Update a ComponentupdateAComponent | PUT | This operation allows you to update an existing component for an asset. |
Update an AssetupdateAnAsset | PUT | This operation allows you to update an existing asset. |
View a RelationshipviewARelationship | GET | This operation allows you to view a particular relationship in your Freshservice account. |
View an AssetviewAnAsset | GET | This operation allows you to view a particular asset. |
View List of AssetslistAssets | GET | Lists all the assets in your Freshservice account. |
Assets Itam7
Create an assetcreateAnAssetForFreshserviceItam | POST | This API helps you create an asset. |
Create or update custom fieldcreateOrUpdateCustomFieldOfAssetsForFreshserviceItam | PUT | This API helps you create or update custom fields data for assets. |
Delete an assetdeleteAnAssetForFreshserviceItam | DELETE | This API helps you delete an asset record by its unique identifier. |
Update an assetupdateAnAssetForFreshserviceItam | PUT | This API helps you update an existing asset by using either the identifier or asset name. |
Update an asset by IDupdateAnAssetByIdForFreshserviceItam | PUT | This API helps you update an existing asset by using the identifier of the asset. |
View an assetviewAnAssetForFreshserviceItam | GET | This API helps you retrieve an asset record by its unique identifier. |
View list of assetsviewAllAssetsForFreshserviceItam | GET | This API helps you retrieve a list of existing assets. |
Attachment2
Download AttachmentdownloadAttachment | GET | This API helps you to download attachments of Ticket, Problem, Change, Release, Solution Article and Asset. |
Download Purchase order and Contracts AttachmentdownloadPurchaseAndContractAttachment | GET | This API helps you to download attachments of Purchase order and Contract. |
Audit Logs1
Audit Log ExportexportAuditLogs | POST | This API helps to export the changes made inside your service desk. |
Business Hours2
View a Business Hours ConfigurationviewABusinessHour | GET | Retrieve the Business Hours Configuration with the given ID from Freshservice/Freshservice for Business Teams |
View List of Business Hours ConfigurationslistAllBusinessHours | GET | Retrieve a list of all business hours configurations in Freshservice/Freshservice for Business Teams. |
Cabs5
Create a CABcreateACab | POST | Note: A maximum of 100 user IDs can be be passed to add members at a time. |
Delete a CABdeleteACab | DELETE | Note: 1. |
List all CABsviewAllCabs | GET | Note: All the below requests are paginated to return only 30 CABS per page as default. |
Update a CABupdateACab | PATCH | Note: A maximum of 100 user IDs can be be passed to add members or remove members at a time. |
View a CABviewACab | GET | Use 'include' to embed additional details in the response. |
Canned Responses5
List all Canned Responses In a FolderlistAllCannedResponseInFolder | GET | This API lists all the Canned Response Folders that are present in the folder. |
Show a Canned ResponseshowCannedResponse | GET | This API show a specific Canned Response |
Show a Canned Response FoldershowCannedResponseFolder | GET | This API show a specific Canned Response |
View List of Canned Response FolderslistAllCannedResponseFolders | GET | This API lists all the canned response folders that are present in the account. |
View List of Canned ResponseslistAllCannedResponses | GET | This API lists all the canned responses that are present in the folder. |
Changes33
Cancel a Change ApprovalcancelChangeApproval | PUT | Cancel 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 RequestcancelChangeApprovalGroups | PUT | Cancel Approval Group In A Change Request |
Create a ChangecreateChange | POST | Create 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 filescreateChangeMultipart | POST | Create 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 NotecreateChangeNote | POST | Create a new note on a change request in freshservice. |
Create a TaskcreateChangeTask | POST | Create a new task on a change request in freshservice. |
Create a Time EntrycreateTimeEntries | POST | Create a new time entry on a change request in freshservice. |
Create an Approval Group for ChangescreateChangeApprovalGroups | POST | Create an Approval Group for a Change Note: "email content" is an optional parameter for sending approval. |
Delete a ChangedeleteAChange | DELETE | Delete the Change request with the given ID from Freshservice. |
Delete a NotedeleteAChangeNote | DELETE | Delete the note on a Change request with the given ID from Freshservice. |
Delete a TaskdeleteAChangeTask | DELETE | Delete the task on a Change request with the given ID from Freshservice Note: Deleted tasks are permanently lost. |
Delete a Time EntrydeleteATimeEntry | DELETE | Delete the time entry on a Change request with the given ID from Freshservice. |
List all Approval Groups within a ChangelistAllChangeApprovalGroups | GET | List all Approval Groups in a Change. |
List all Change ApprovalslistAllChangeApprovals | GET | Retrieve all approvals in a Change with the given ID from Freshservice. |
List all Change FieldsviewAllChangeFields | GET | Retrieve 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 EntriesviewAllTimeEntries | GET | Retrieve the time entries on a Change request with the given ID from Freshservice. |
Move a ChangemoveAChange | PUT | This API moves a change to a different workspace, while also allowing the assigned group and agent to be modified. |
Send Reminder for a Change ApprovalresendReminderChangeApproval | PUT | Resends a reminder for a specific Approval raised for the Change |
Update a ChangeupdateChangePriority | PUT | Update an existing Change request in Freshservice Note: The workspace id attribute cannot be updated through the Update operation. |
Update a Change with filesupdateChangePriorityMultipart | PUT | Update an existing Change request in Freshservice Note: The workspace id attribute cannot be updated through the Update operation. |
Update a NoteupdateAChangeNote | PUT | Update an existing note on an existing Change request in Freshservice. |
Update a TaskupdateAChangeTask | PUT | Update an existing task on an existing Change request in Freshservice |
Update a Time EntryupdateTimeEntry | PUT | Update an existing time entry on an existing Change request in Freshservice. |
Update approval chain rule for a changeupdateApprovalChainRuleChange | PUT | Update the approval chain rule for a change |
Update Approval Group In A Change RequestupdateChangeApprovalGroups | PUT | Update Approval Group In A Change Request Note: "email content" is an optional parameter for sending approval. |
View a ChangeviewAChange | GET | Use 'include' to embed additional details in the response. |
View a Change ApprovalviewAChangeApproval | GET | Retrieve an approval on a Change with the given ID from Freshservice |
View a NoteviewAChangeNote | GET | Retrieve a note on a Change request with the given ID from Freshservice. |
View a TaskviewAChangeTask | GET | Retrieve a task on a Change request with the given ID from Freshservice |
View a Time EntryviewATimeEntry | GET | Retrieve a time entry on a Change request with the given ID from Freshservice. |
View all NotesviewAllChangeNotes | GET | Retrieve a list of all notes on a Change request with the given ID from Freshservice. |
View all TasksviewAllChangeTasks | GET | Retrieve the tasks on a Change request with the given ID from Freshservice. |
View List of ChangeslistChanges | GET | Use filters to view changes based on the criteria that you choose. |
Cloud Infrastructure4
Create or update custom fieldupdateCustomFieldOfCloudInfrastructure | PUT | This API helps you create or update custom fields data for the cloud account. |
Delete cloud detailsdeleteCloudInfrastructure | DELETE | This API helps you delete a cloud account ID and all attached cloud resources. |
Update cloud detailsupdateCloudInfrastructure | POST | This API helps you update a cloud infrastructure for AWS discovery. |
View cloud detailsviewAllCloudInfrastructure | GET | This API helps you retrieve a list of cloud resources for AWS discovery. |
Collaborate7
Retrieve emails related to a ticketretrieveEmails | GET | Retrieve emails associated to a major incident by ticket ID Note: This API is triggered only for tickettype = Major Incident. |
Retrieve specific emails using IDretrieveEmailsWithId | GET | Retrieve 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 ticketretrieveZoomMeetings | GET | Retrieve past or ongoing Zoom meetings for a ticket. |
Retrieve zoom meetings related to a ticket with IDretrieveZoomMeetingsWithId | GET | Retrieve past or ongoing Zoom meetings for a ticket with the ID. |
Trigger a new zoom meetingtriggerNewMeeting | POST | Trigger a Zoom meeting to collaborate on the ticket. |
Trigger an Email with attachment for a Major IncidenttriggerEmailWithAttachment | POST | Send an email related to a ticket or incident with attachments. |
Trigger email for a major incidenttriggerEmail | POST | Notify major incidents via email. |
Contracts14
Approve a ContractapproveContract | PUT | This operation allows you to approve a contract in the account. |
Create a ContractcreateAContract | POST | This operation allows you to create a new contract in Freshservice. |
Create a Contract with associated assetscreateContractWithAssociatedAssets | POST | This API lets you create a new Contract with associated Assets (CIs) in your service desk. |
Create a Contract with attachmentcreateContractWithAttachment | POST | Note: 1. |
List all associated assets of a contractlistAllAssociatedAssets | GET | This operation allows you to view information about all the associated asset of a contract. |
List all attachments of a contractlistAllAttachments | GET | This operation allows you to view information about all the attachments of a contract. |
List all contract typeslistAllContractTypes | GET | This operation allows you to view a list of all contract type. |
List all contractslistAllContracts | GET | This operation allows you to view a list of all contracts. |
List all fields of a contract typelistAllContractTypeFields | GET | This operation allows you to view all fields of a contract type. |
Move a ContractmoveAContract | PUT | This API moves a contract to a different workspace, while also allowing the visibility group to be modified. |
Reject a ContractrejectContract | PUT | This operation allows you to reject a contract in the account. |
Submit a contract for approvalsubmitContractForApproval | PUT | This operation allows you to submit a contract for approval in the account. |
Update a ContractupdateAContract | PUT | Note: The workspace id attribute cannot be updated through the Update operation. |
View a contractviewAContract | GET | This operation allows you to view a particular contract. |
Conversations8
Create a NoteaddNote | POST | Note: By default, any note that you add will be private. |
Create a ReplyreplyTicket | POST | Note: 1. |
Create a Reply with filesreplyTicketMultipart | POST | Note: 1. |
Delete a ConversationdeleteAConversations | DELETE | Delete a Conversation Freshservice Freshservice for Business Teams Freshservice for MSPs |
Delete a Conversation AttachmentdeleteAConversationAttachment | DELETE | This API helps you delete an attachment from a conversation. |
List all Conversations of a TicketlistConversations | GET | This API helps you List All Conversations of a Ticket. |
Update a ConversationupdateAConversations | PUT | Note: Only public & private notes can be edited. |
Update a Conversation with filesupdateAConversationsMultipart | PUT | Note: Only public & private notes can be edited. |
Custom Objects6
Create new Custom Object RecordcreateCustomObjectRecord | POST | This API creates a new record in a Custom object. |
Delete Custom Object RecorddeleteCustomObjectRecord | DELETE | This API deletes an existing record in a Custom object. |
List all records of a Custom ObjectlistAllCustomObjectRecords | GET | This API lists all the records present in a given Custom object. |
Show a Custom ObjectshowCustomObject | GET | This API gives you the details of a given Custom object like field names, options for dropdown fields etc. |
Update Custom Object RecordputCustomObjectRecord | PUT | This API updates the value of the given fields of a record in a Custom object. |
View List of Custom ObjectslistAllCustomObjects | GET | This API lists all the Custom objects that are present in the account. |
Delegation4
Create a delegationcreateDelegation | POST | Use this API to create a new delegation period for a specific user. |
Delete a delegationdeleteDelegation | DELETE | Use this API to delete an existing delegation. |
Update a delegationupdateDelegation | PUT | Use this API to update the delegation information such as duration or notes of an existing delegation. |
View a delegationviewDelegation | GET | Use this API to view the current delegation details associated with a user. |
Departments7
Create a DepartmentcreateADepartment | POST | Note: You cannot create departments for workspace id=1 (Global). |
Delete a DepartmentdeleteADepartment | DELETE | Delete the Department (or Company in MSP Mode) with the given ID from Freshservice. |
Filter DepartmentsfilterDepartments | GET | Use Departments (or Companies in MSP Mode) attributes to filter your list. |
List all Department FieldslistAllDepartmentFields | GET | Retrieve the Department Fields (or Company Fields in MSP Mode) from Freshservice. |
List all DepartmentslistAllDepartments | GET | Note: 1. |
Update a DepartmentupdateADepartment | PUT | Update an existing Department (or Company in MSP Mode) in Freshservice/Freshservice for Business Teams. |
View a DepartmentviewADepartment | GET | Retrieve the Department (or Company in MSP Mode) with the given ID from Freshservice |
Devices6
Create a devicecreateDevice | POST | This API helps you create or update devices. |
Create or update custom fieldupdateCustomFieldOfDevices | PUT | This 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 devicedeleteDevice | DELETE | This API helps you delete a device record by its unique identifier. |
Update a deviceupdateDevice | PUT | This API helps you update a device record by ID. |
View a deviceviewADevice | GET | This API helps you retrieve a device record by its unique identifier. |
View list of all devicesviewAllDevices | GET | This API helps you retrieve information about all devices. |
Employee Offboarding5
Create an Offboarding RequestcreateOffboardingRequest | POST | This API helps you to create a new Offboarding Request in your service desk. |
View all Offboarding RequestslistAllOffboardingRequests | GET | This API lets you view all the Offboarding Requests in your service desk. |
View an Offboarding RequestviewOffboardingRequest | GET | This API lets you retrieve and view a specific Offboarding Request in your service desk. |
View Offboarding Form FieldsoffboardingForm | GET | This API lets you view all the fields in the Initiator’s Offboarding form. |
View Offboarding TicketsviewOffboardingTickets | GET | This API lets you retrieve and view the Offboarding Tickets associated with an Offboarding Request. |
Employee Onboarding5
Create an Onboarding RequestcreateOnboardingRequest | POST | This API helps you to create a new Onboarding Request in your service desk. |
View all Onboarding RequestslistAllOnboardingRequests | GET | This API lets you view all the Onboarding Requests in your service desk. |
View an Onboarding RequestviewOnboardingRequest | GET | This API lets you retrieve and view a specific Onboarding Request in your service desk. |
View Onboarding Form FieldsonboardingForm | GET | This API lets you view all the fields in the Initiator’s Onboarding form. |
View Onboarding TicketsviewOnboardingTickets | GET | This API lets you retrieve and view the Onboarding Tickets associated with an Onboarding Request. |
Journeys10
Cancel a Journey RequestcancelJourneyRequest | PUT | This API cancels the specified Journey Request from Freshservice. |
Create a Journey RequestcreateJourneyRequest | POST | This API allows you to initiate a new Journey Request in Freshservice/Freshservice for Business Teams. |
Delete a Journey RequestdeleteJourneyRequest | DELETE | This API deletes the specified Journey Request from Freshservice. |
Filter Journey RequestsfilterJourneyRequests | POST | This API retrieves a list of Journey Requests that match the specified filter criteria. |
Update a Journey RequestupdateJourneyRequest | PATCH | This API updates the details of an existing Journey Request in Freshservice. |
View a Journey RequestviewJourneyRequest | GET | Note: Only users with View Journey Requests privilege can access the following API. |
View Journey Initiator Config Form FieldsjourneyInitiatorConfigForm | GET | This API retrieves all fields from the Initiator Form of a Journey configuration. |
View Journey Request ActivitiesviewJourneyRequestActivities | GET | This API lists all activities associated with a specific Journey Request across its various phases,identified by the Journey Request ID. |
View List of Journey RequestsviewAllJourneyRequests | GET | This API returns a filtered list of Journey Requests, excluding deleted entries by default. |
View List of Published Journeys ConfigsjourneyConfigs | GET | Note: 1. |
Lifecycle Events4
Create or update lifecycle eventsupdateLifecycleEvents | PUT | This API helps you create or update lifecycle events for devices and assets. |
Delete a lifecycle eventdeleteLifecycleEvent | DELETE | This API helps you delete a lifecycle event record by its unique identifier. |
View a lifecycle eventviewALifecycleEvent | GET | This API helps you retrieve a lifecycle event record by its unique identifier. |
View list of all lifecycle eventsviewAllLifecycleEvents | GET | This API helps you retrieve a list of existing lifecycle events. |
Locations6
Create a LocationcreateALocation | POST | This operation allows you to create a new location in Freshservice/Freshservice for Business Teams. |
Delete a LocationdeleteALocation | DELETE | This operation allows you to delete a particular location. |
Filter LocationsfilterLocations | GET | You can filter locations by their Name. |
List all LocationslistAllLocations | GET | This operation allows you to view information about all the locations in the account. |
Update a LocationupdateALocation | PUT | This operation allows you to update an existing location. |
View a LocationviewALocation | GET | This operation allows you to view information about a particular location. |
Oncall Management34
Create a schedulecreateSchedule | POST | This 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 shiftcreateShift | POST | This 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 policycreateEp | POST | This 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 overrideoverride | PUT | This 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 scheduledeleteSchedule | DELETE | This 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 shiftdeleteShift | DELETE | This 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 policydeleteEp | DELETE | This 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 scheduleexportIcalCalendarEventsSchedule | GET | This 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 shiftexportIcalCalendarEventsShift | GET | This 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 userexportIcalCalendarEventsUser | GET | This 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 userexportIcalCalendarEventsScheduleUser | GET | This 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 userexportIcalCalendarEventsShiftUser | GET | This 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 scheduleexportCalendarEventsSchedule | GET | This operation enables you to export all on-call events for a schedule as a webcal link. |
Export oncall calendar events for a shiftexportCalendarEventsShift | GET | This 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 userexportCalendarEventsUser | GET | This 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 userexportCalendarEventsScheduleUser | GET | This 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 userexportCalendarEventsShiftUser | GET | This operation enables you to export all on-call events for a shift within a schedule for a specific user as a webcal link. |
Filter schedulesfilterSchedules | GET | This 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 policyreorderEp | PUT | This operation lets you re-order the escalation policies (EP) within an on-call schedule. |
Update a scheduleeditSchedule | PUT | This 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 shifteditShift | PUT | This 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 policyeditEp | PUT | This 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 scheduleviewASchedule | GET | This 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 shiftviewAShift | GET | This 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 policiesviewAllEp | GET | This 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 schedulesviewAllSchedules | GET | This 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 shiftsviewAllShifts | GET | This 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 policyviewAEp | GET | This 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 scheduleviewCalendarEventsSchedule | GET | This 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 shiftviewCalendarEventsShift | GET | This 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 userviewCalendarEventsUser | GET | This 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 userviewCalendarEventsScheduleUser | GET | This 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 userviewCalendarEventsShiftUser | GET | This 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 oncallviewWhoIsOncall | GET | This 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 subtypescreatePhysicalSubtype | POST | This API helps you create or update physical subtypes. |
Delete a physical subtypedeletePhysicalSubtype | DELETE | This API helps you delete a physical subtype record by its unique identifier. |
View a physical subtypeviewAPhysicalSubtype | GET | This API helps you retrieve a physical subtype record by its unique identifier. |
View list of physical subtypesviewAllPhysicalSubtypes | GET | This API helps you retrieve all device physical subtypes. |
Post Incident Reports7
Create new templates for post-incident reportscreateNewTemplate | POST | Design a new post-incident report template. |
Delete an existing post-incident report templatedeletePirTemplate | DELETE | Remove an existing PIR template. |
Enable template for post-incident reportsenablePirTemplate | PUT | Enable post-incident report templates. |
Export the post-incident report templateexportPirTemplate | POST | Export templates of post-incident reports as a PDF or DOCX file. |
Get all post-incident report templatesgetAllPirTemplates | GET | Retrieve all PIR templates in a workspace. |
Get post-incident report templates by IDgetPirTemplatesById | GET | Retrieve a specific PIR template using its ID (PIR-ID) |
Set template as primary for post-incident reportsmarkPrimaryPirTemplate | PUT | Set a template as primary for post-incident reports. |
Problems24
Create a notecreateProblemNote | POST | Create a new note on a problem request in freshservice. |
Create a ProblemcreateProblem | POST | Create a new problem request in Freshservice Note: 1. |
Create a Problem with filescreateProblemMultipart | POST | Create a new problem request in Freshservice Note: 1. |
Create a TaskcreateProblemTask | POST | Create a new task on a problem in freshservice |
Create a Time EntrycreateProblemTimeEntries | POST | Create a new time entry on a problem request in freshservice. |
Delete a notedeleteAProblemNote | DELETE | Delete the note on a Problem request with the given ID from Freshservice. |
Delete a ProblemdeleteAProblem | DELETE | Delete the Problem with the given ID from Freshservice |
Delete a TaskdeleteAProblemTask | DELETE | Delete the task on a Problem with the given ID from Freshservice Note: Deleted tasks are permanently lost. |
Delete a Time EntrydeleteAProblemTimeEntry | DELETE | Delete the time entry on a Problem request with the given ID from Freshservice. |
List all Problem FieldsviewAllProblemFields | GET | Retrieve 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 EntriesviewAllProblemTimeEntries | GET | Retrieve the time entries on a Problems request with the given ID from Freshservice. |
Move a ProblemmoveAProblem | PUT | This API moves a problem to a different workspace, while also allowing the assigned group and agent to be modified. |
Restore a ProblemrestoreAProblem | PUT | |
Update a noteupdateAProblemNote | PUT | Update an existing note on an existing Problem request in Freshservice. |
Update a ProblemupdateProblemPriority | PUT | Update an existing Problem in Freshservice Note: The workspace id attribute cannot be updated through the Update operation. |
Update a TaskupdateAProblemTask | PUT | Update an existing task on an existing Problem in Freshservice |
Update a Time EntryupdateProblemTimeEntry | PUT | Update an existing time entry on an existing Problem request in Freshservice. |
View a noteviewAProblemNote | GET | Retrieve a note on a Problem request with the given ID from Freshservice. |
View a ProblemviewAProblem | GET | Retrieve the problem with the given ID from Freshservice |
View a TaskviewAProblemTask | GET | Retrieve a task on a Problem with the given ID from Freshservice |
View a Time EntryviewAProblemTimeEntry | GET | Retrieve a time entry on a Problem request with the given ID from Freshservice. |
View all notesviewAllProblemNotes | GET | Retrieve a list of all notes on a Problem request with the given ID from Freshservice. |
View all TasksviewAllProblemTasks | GET | Retrieve the tasks on a Problem with the given ID from Freshservice |
View List of ProblemslistProblems | GET | Retrieve 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 ProductcreateAProduct | POST | This operation allows you to create a new product in Freshservice. |
Delete a ProductdeleteAProduct | DELETE | This operation allows you to delete a particular product. |
List all ProductsviewAllProducts | GET | This operation allows you to view information about all products in the account. |
Update a ProductupdateAProduct | PUT | This operation allows you to update an existing product. |
View a ProductviewAProduct | GET | This operation allows you to view a particular product. |
Project Tasks5
Create a Project TaskcreateAProjectTask | POST | Create a Project Task Freshservice Freshservice for Business Teams |
Delete a Project TaskdeleteAProjectTask | DELETE | This API helps you delete a project task. |
List all Project TasksviewAllProjectTasks | GET | List all Project Tasks Freshservice Freshservice for Business Teams |
Update a Project TaskupdateAProjectTask | PUT | Update a Project Task Freshservice Freshservice for Business Teams |
View a Project TaskviewAProjectTask | GET | View a Project Task Freshservice Freshservice for Business Teams |
Project Tasks Newgen26
Create a Project TaskcreateAProjectTaskNewgen | POST | This API lets you create a project task. |
Create a Project Task with filescreateAProjectTaskNewgenMultipart | POST | This API lets you create a project task. |
Create AssociationscreateProjectTaskAssociations | POST | This API allows you to associate a task with specific Tickets, Problems, Changes or Assets. |
Create NotecreateNoteTaskNewgen | POST | This API allows you to add a note to a task. |
Create Note with filescreateNoteTaskNewgenMultipart | POST | This API allows you to add a note to a task. |
Delete a Project TaskdeleteAProjectTaskNewgen | DELETE | This API helps you delete a project task. |
Delete AssociationdeleteProjectTaskAssociation | DELETE | This API allows you to delete an association of a project task. |
Delete Attachment of a NotedeleteAttachmentNoteTaskNewgen | DELETE | This API allows you to delete an attachment of a note. |
Delete Attachment of a TaskdeleteAttachmentTaskNewgen | DELETE | This API allows you to delete an attachment of a task. |
Delete NotedeleteNoteTaskNewgen | DELETE | This API allows you to delete a note. |
Filter all Project TasksfilterAllProjectTasksNewgen | GET | Get a list of tasks matching the specified task fields. |
List all Project TasksviewAllProjectTasksNewgen | GET | List all Project Tasks Freshservice Freshservice for Business Teams |
Update a Project TaskupdateAProjectTaskNewgen | PUT | This API lets you update a project task Note: 1. |
Update a Project Task with filesupdateAProjectTaskNewgenMultipart | PUT | This API lets you update a project task Note: 1. |
Update NoteupdateNoteTaskNewgen | PUT | This API allows you to update a note. |
Update Note with filesupdateNoteTaskNewgenMultipart | PUT | This API allows you to update a note. |
View a Project TaskviewAProjectTaskNewgen | GET | This API lets you view the details of a project task |
View AssociationsviewProjectTaskAssociations | GET | This API allows you to view all associations of a project task by module. |
View NotesviewNotesTaskNewgen | GET | This API allows you to view all task notes. |
View Project MembershipsviewProjectMemberships | GET | This API lists all the members that are present in a project. |
View Project SprintsviewProjectSprints | GET | This API lists all the sprints that have been created in a project. |
View Project Task PrioritiesviewProjectTaskPriorities | GET | This API lists all the priority levels that have been created in a project. |
View Project Task StatusesviewProjectTaskStatuses | GET | This API lists all the task statuses that have been defined in a project. |
View Project Task Type FieldsviewProjectTaskTypeFields | GET | This API lets you list the fields of a specifc task type from your project. |
View Project Task TypesviewProjectTaskTypes | GET | This API lists all the task types that are present in a project. |
View Project VersionsviewProjectVersions | GET | This API lists all the versions that have been created in a project. |
Projects7
Archive a ProjectarchiveAProject | POST | This API helps you archive a project. |
Create a ProjectcreateAProject | POST | Create a Project Freshservice Freshservice for Business Teams |
Delete a ProjectdeleteAProject | DELETE | This API helps you permanently delete a project. |
List all ProjectsviewAllProjects | GET | List all Projects Freshservice Freshservice for Business Teams |
Restore a ProjectrestoreAProject | POST | You can restore an archived project using this API. |
Update a ProjectupdateAProject | PUT | Update a Project Freshservice Freshservice for Business Teams |
View a ProjectviewAProject | GET | View a Project Freshservice Freshservice for Business Teams |
Projects Newgen16
Add MembersaddProjectMembers | POST | This API allows you to add one or more members to a project. |
Archive a ProjectarchiveAProjectNewgen | POST | Note: Archived projects are not permanently lost. |
Create a ProjectcreateAProjectNewgen | POST | This API helps you create a new project in your service desk Note: 1. |
Create a Project with filescreateAProjectNewgenMultipart | POST | This API helps you create a new project in your service desk Note: 1. |
Create AssociationscreateProjectAssociations | POST | This API allows you to associate a Project with specific Tickets, Problems, Changes or Assets. |
Delete a ProjectdeleteAProjectNewgen | DELETE | This API lets you permanently delete a project. |
Delete AssociationdeleteProjectAssociation | DELETE | This API allows you to delete an association of a project. |
Delete Attachment of a ProjectdeleteAttachmentProjectNewgen | DELETE | This API allows you to delete an attachment of a project. |
List all ProjectsviewAllProjectsNewgen | GET | List all Projects Freshservice Freshservice for Business Teams |
Restore a ProjectrestoreAProjectNewgen | POST | You can restore an archived project using this API. |
Update a ProjectupdateAProjectNewgen | PUT | This API lets you update the properties of a project. |
Update a Project with filesupdateAProjectNewgenMultipart | PUT | This API lets you update the properties of a project. |
View a ProjectviewAProjectNewgen | GET | This API lets you view the details of a project. |
View AssociationsviewProjectAssociations | GET | This API allows you to delete an association of a project. |
View Project FieldsviewProjectFields | GET | View Project Fields Freshservice Freshservice for Business Teams |
View Project TemplatesviewProjectTemplates | GET | View Project Templates Freshservice Freshservice for Business Teams |
Purchase Order6
Create a new Purchase OrdercreateANewPurchaseOrder | POST | This operation allows you to Create a new Purchase Order in Freshservice. |
Delete a Purchase OrderdeleteAPurchaseOrder | DELETE | This operation allows you to delete a particular purchase order. |
List all Purchase OrderslistAllPurchaseOrders | GET | This operation allows you to view information about all the purchase orders in Freshservice. |
Move a Purchase OrdermoveAPurchaseOrder | PUT | This API moves a purchase order to a different workspace. |
Update a Purchase OrderupdateAPurchaseOrder | PUT | This operation allows you to update an existing purchase order. |
View a Purchase OrderviewAPurchaseOrder | GET | This operation allows you to view a particular purchase order. |
Releases25
Create a notecreateReleaseNote | POST | Create a new note on a release request in freshservice. |
Create a ReleasecreateRelease | POST | Create a new Release request in Freshservice Note: 1. |
Create a Release with filescreateReleaseMultipart | POST | Create a new Release request in Freshservice Note: 1. |
Create a TaskcreateReleaseTask | POST | Create a new task on a release in freshservice |
Create a Time EntrycreateReleaseTimeEntries | POST | Create a new time entry on a release request in freshservice. |
Delete a notedeleteAReleaseNote | DELETE | Delete the note on a Release request with the given ID from Freshservice. |
Delete a ReleasedeleteARelease | DELETE | Delete the Release with the given ID from Freshservice |
Delete a TaskdeleteAReleaseTask | DELETE | Delete the task on a Release with the given ID from Freshservice Note: Deleted tasks are permanently lost. |
Delete a Time EntrydeleteAReleaseTimeEntry | DELETE | Delete the time entry on a Release request with the given ID from Freshservice. |
Filter ReleasesfilterReleases | GET | This API helps you to view all the releases in your service desk. |
List all Time EntriesviewAllReleaseTimeEntries | GET | Retrieve the time entries on a Release request with the given ID from Freshservice. |
Move a ReleasemoveARelease | PUT | This API moves a release to a different workspace, while also allowing the assigned group and agent to be modified. |
Restore a ReleaserestoreARelease | PUT | |
Update a noteupdateAReleaseNote | PUT | Update an existing note on an existing Release request in Freshservice. |
Update a ReleaseupdateReleasePriority | PUT | Update an existing Release in Freshservice Note: The workspace id attribute cannot be updated through the Update operation. |
Update a TaskupdateAReleaseTask | PUT | Update an existing task on an existing Release in Freshservice |
Update a Time EntryupdateReleaseTimeEntry | PUT | Update an existing time entry on an existing Release request in Freshservice. |
View a noteviewAReleaseNote | GET | Retrieve a note on a Release request with the given ID from Freshservice. |
View a ReleaseviewARelease | GET | Retrieve the Release with the given ID from Freshservice |
View a TaskviewAReleaseTask | GET | Retrieve a task on a Release with the given ID from Freshservice |
View a Time EntryviewAReleaseTimeEntry | GET | Retrieve a time entry on a Release request with the given ID from Freshservice. |
View all notesviewAllReleaseNotes | GET | Retrieve a list of all notes on a Release request with the given ID from Freshservice. |
View all Release FieldsviewAllReleaseFields | GET | Retrieve 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 TasksviewAllReleaseTasks | GET | Retrieve the tasks on a Release with the given ID from Freshservice |
View list of ReleasesviewAllRelease | GET | Retrieve 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 GroupaddMemberToRequesterGroup | POST | Note: 1.Requesters/contacts can be added only to manual requester groups. |
Create a Requester Group/Contact GroupcreateARequesterGroup | POST | Note: Only groups of type “manual” can be created through this API. |
Delete a Requester Group/Contact GroupdeleteARequesterGroup | DELETE | Note: 1. |
Delete Requester/Contact from Requester/Contact GroupdeleteMemberFromRequesterGroup | DELETE | Note: 1.Requesters/Contacts can be removed only from manual requester groups. |
List All Requester Groups/Contact GroupsviewAllRequesterGroup | GET | Note: Groups of both types (“manual”/”rule based”) can be listed through this API. |
List Requester/Contact Group MemberslistMembersOfRequesterGroup | GET | List Requester/Contact Group Members Freshservice Freshservice for Business Teams Freshservice for MSPs |
Update a Requester Group/Contact GroupupdateARequesterGroup | PUT | Note: Only groups of type “manual” can be updated through this API. |
View a Requester Group/Contact GroupviewARequesterGroup | GET | Note: Groups of both types (“manual”/”rule based”) can be viewed through this API. |
Requesters12
Convert To AgentconvertToAgent | PUT | Convert a requester to an occasional agent with SD Agent role and no group memberships. |
Create a Requester/ContactcreateARequester | POST | This operation allows you to create a new requester. |
Deactivate a Requester/ContactdeactivateARequester | DELETE | This operation allows you to deactivate a requester. |
Filter Requester/ContactfilterRequesters | GET | Use Requester/Contacts attributes to filter your list. |
Forget a Requester/ContactforgetARequester | DELETE | This operation allows you to permanently delete a requester and the tickets that they requested. |
List All Requester/Contact FieldslistAllRequesterFields | GET | This operation allows you to view all the built-in and custom fields for requesters in your Freshservice account. |
List All Requesters/ContactslistRequesters | GET | This operation returns a list of all requester/contact in the account. |
Merge Requesters/ContactsmergeRequesters | PUT | Merge secondary requesters into a primary requester. |
Reactivate a Requester/ContactreactivateARequester | PUT | This operation allows you to reactivate a particular deactivated requester. |
Update a Requester/ContactupdateARequester | PUT | This operation allows you to modify the profile of a particular requester. |
User Assignment HistoryuserAssignmentHistory | GET | This operation retrieves the assignment history of a specific user in Freshservice. |
View a Requester/ContactviewARequester | GET | This operation allows you to view information about a requester or contact. |
Resource Relationships2
Delete a cloud resource relationshipdeleteCloudResourceRelationship | DELETE | This API helps you delete a cloud resource relationship ID and attached resource relationships. |
View list of all cloud resource relationshipsviewAllCloudResourceRelationships | GET | This API helps you retrieve a list of cloud resource relationships for AWS. |
Resources5
Create or update custom fieldupdateCustomFieldOfResources | PUT | This API helps you create or update custom fields data for cloud resources. |
Delete a cloud resourcedeleteCloudResource | DELETE | This API helps you delete a cloud resource by ID and all attached resources. |
Update a cloud resourceupdateCloudResource | POST | This API helps you update a cloud resource for AWS discovery. |
View a cloud resourceviewACloudResource | GET | This API helps you retrieve details of a particular cloud resources for AWS discovery. |
View list of all cloud resourcesviewAllCloudResources | GET | This API helps you retrieve a list of cloud resources for AWS discovery. |
Service Catalog16
Archive shared fieldsarchiveSharedFields | POST | Archive a shared field using this API |
Create a Service Catalog Item with agent group visibilitiescreateServiceCatalogItemWithAgentGroupVisibilities | POST | Create a Service Catalog Item with agent group visibilities Freshservice Freshservice for MSPs |
Create a Service Catalog Item With Shared FieldscreateServiceCatalogItemWithSharedFields | POST | Create a Service Catalog Item With Shared Fields Freshservice Freshservice for MSPs |
Create a shared fieldcreateSharedFields | POST | Create shared fields. |
Create Service Catalog itemcreateServiceCatalogItem | POST | This operation allows you to create a new service item in Freshservice/Freshservice for Business Teams. |
Delete a Service Catalog ItemdeleteAServiceItem | DELETE | This API allows you to delete a service item. |
Delete shared fieldsdeleteSharedFields | DELETE | Delete shared fields with this API. |
List all shared fields based on searchsharedFields | GET | Retrieve a list of all shared fields. |
Retrieve shared fields dataretrieveSharedFieldsData | GET | Retrieve shared field data for individual fields. |
Search Service ItemssearchServiceItem | GET | Search for service items from the service catalog for a given search term. |
Unarchive shared fieldsunarchiveSharedFields | POST | This API unarchives a shared field. |
Update a Service Catalog ItemupdateServiceItem | PUT | Update an existing service item. |
Update shared fieldsupdateSharedFields | PUT | Updates shared fields with relevant field values. |
View a Service ItemviewServiceItem | GET | This API allows you to view the details of a service item. |
View List of Service CategorieslistAllServiceCategories | GET | This 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 ItemslistAllServiceItems | GET | This API lists all service items in your Freshservice service desk. |
Sla Policies1
View List of SLAslistAllSla | GET | This API helps to view all time entries of a particular ticket. |
Software17
Add a device to a SoftwarecreateAnInstallations | POST | This operation allows you to add a new device to a Software. |
Add Users to a Software in bulkbulkCreateUsers | POST | This operation allows you to add Users to a Software in bulk. |
Create a SoftwarecreateASoftware | POST | This operation allows you to create a new software in Freshservice. |
Delete a SoftwaredeleteASoftware | DELETE | This operation allows you to delete a particular software. |
Delete multiple SoftwaredeleteMultipleSoftware | DELETE | This operation allows you to delete multiple software. |
List all installations of a SoftwarelistInstallations | GET | This operation allows you to view the list of all the devices where the Software is installed in. |
List all LicenseslistAllLicenses | GET | This operation allows you to list all licenses of a software. |
List all Relationships for a SoftwarelistRelationshipsOfASoftware | GET | Lists all the relationships of a particular software. |
List all SoftwarelistAllSoftware | GET | This operation allows you to list all software. |
List all Users of a SoftwarelistUsers | GET | This operation allows you to view the list of users using a particular Software. |
Move a SoftwaremoveASoftware | PUT | This API moves a software to a different workspace. |
Remove devices from a Software in bulkbulkDeleteInstallations | DELETE | This operation allows you to remove devices from a Software in bulk. |
Remove Users from a Software in bulkbulkDeleteUsers | DELETE | This operation allows you to remove Users from a Software in bulk. |
Update a SoftwareupdateASoftware | PUT | This operation allows you to update an existing software. |
Update Users of a Software in bulkbulkUpdateUsers | PUT | This operation allows you to update Users of a Software in bulk. |
View a SoftwareviewASoftware | GET | This operation allows you to view a particular software. |
View a Software UserviewUser | GET | This operation allows you to view a particular Software User. |
Solution Article14
Bulk Restore Solution ArticlesbulkRestoreSolutionArticle | PUT | Restore multiple articles from Trash. |
Create Article from External URLcreateExternalArticle | POST | To write a new solution external article in a category, use this API. |
Create Article With AttachmentcreateSolutionArticleWithAttachment | POST | To write a new solution article with attachments in a category, use this API. |
Create Secondary Language ArticlecreateSecondaryLanguageArticle | POST | To create a secondary language article and link it to a primary language article, use this API |
Create Solution ArticlecreateSolutionArticle | POST | To write a new solution article in a category, use this API. |
Delete Solution ArticledeleteSolutionArticle | DELETE | To delete a solution article, use this API. |
Permanently Delete Solution ArticledeleteForeverSolutionArticle | DELETE | Permanently delete an article from Trash. |
Publish Solution ArticlepublishSolutionArticle | PUT | To publish an solution article, use this API. |
Restore Solution ArticlerestoreSolutionArticle | PUT | Restore an article from Trash. |
Search Solution ArticlessearchSolutionArticle | GET | Search for articles from the knowledge base for a given search term. |
Send Article to ApprovalsendArticleToApproval | PUT | To send article approval for the review, use this API. |
Update Solution ArticleupdateSolutionArticle | PUT | To update an article, use this API. |
View List of Solution ArticleviewAllSolutionArticle | GET | To view all the articles, use this API. |
View Solution ArticleviewSolutionArticle | GET | If there is a specific article which you wish to view, use this API. |
Solution Category7
Create Solution CategorycreateSolutionCategory | POST | Use this API to create a new category of solutions. |
Delete Solution CategorydeleteSolutionCategory | DELETE | To delete a solution category, use this API. |
Permanently Delete Solution CategorydeleteForeverSolutionCategory | DELETE | Permanently delete a category from Trash. |
Restore Solution CategoryrestoreSolutionCategory | PUT | Restore a category from Trash. |
Update Solution CategoryupdateSolutionCategory | PUT | Use this API to update solution categories. |
View List of Solution CategoriesviewAllSolutionCategory | GET | This API lets you view all the categories in a forum. |
View Solution CategoryviewSolutionCategory | GET | To view the category available in your service desk, use this |
Solution Folder9
Create Solution FoldercreateSolutionFolder | POST | Use this API to create a new folder in your solutions. |
Create Solution Folder with ApprovalcreateSolutionFolderWithApproval | POST | Use this API to create a new folder with approval settings in your solutions. |
Delete Solution FolderdeleteSolutionFolder | DELETE | To delete a solution folder, use this API. |
Permanently Delete Solution FolderdeleteForeverSolutionFolder | DELETE | Permanently delete a folder from Trash. |
Restore Solution FolderrestoreSolutionFolder | PUT | Restore a folder from Trash. |
Update Solution FolderupdateSolutionFolder | PUT | Note: The following parameters can be only updated for Freshservice for MSPs. |
View List of Solution FolderviewAllSolutionFolder | GET | This API lets you view all the folders in a forum for specific category. |
View Solution FolderviewSolutionFolder | GET | To view all folders present in a category, use this API. |
View Solution Sub FoldersviewSolutionSubFolders | GET | To view all sub-folders present in a folder, use this API. |
Status Page39
Create a maintenance from a changecreateMaintenanceFromChange | POST | This operation allows the user to create a maintenance from a change. |
Create a maintenance from a maintenance windowcreateMaintenanceFromMaintenanceWindow | POST | This operation allows the user to create a maintenance from a maintenance window. |
Create a maintenance update from a changecreateMaintenanceUpdateFromChange | POST | This operation allows the user to create an update to maintenance from a change. |
Create a maintenance update from a maintenance windowcreateMaintenanceUpdateFromMaintenanceWindow | POST | This operation allows the user to create an update to maintenance from a maintenance window. |
Create a subscribercreateSubscriber | POST | Use this API to create a new subscriber for a status page. |
Create an incidentcreateIncident | POST | This operation allows the user to create an incident. |
Create incident updatecreateIncidentUpdate | POST | This operation allows the user to post an update to an incident. |
Delete a maintenance from a changedeleteMaintenanceFromChange | DELETE | This operation allows the user to delete the maintenance associated to the change. |
Delete a maintenance from a maintenance windowdeleteMaintenanceFromMaintenanceWindow | DELETE | This operation allows the user to delete the maintenance associated to the maintenance window. |
Delete a maintenance update from a changedeleteMaintenanceUpdateFromChange | DELETE | This operation allows the user to delete the maintenance update associated to the change. |
Delete a maintenance update from a maintenance windowdeleteMaintenanceUpdateFromMaintenanceWindow | DELETE | This operation allows the user to delete the maintenance update associated to the maintenance window. |
Delete a subscriberdeleteSubscriber | DELETE | Use this API to delete a subscriber from the specified status page. |
Delete an incidentdeleteIncident | DELETE | This operation allows the user to delete the incident. |
Delete an incident updatedeleteIncidentUpdate | DELETE | This 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 updateupdateIncidentUpdate | PUT | This operation allows the user to edit an update posted to an incident. |
Identify publishable services from a changeidentifyPublishableServicesChange | GET | Use this API to identify publishable services from a change. |
Identify publishable services from a maintenance windowidentifyPublishableServicesMaintenance | GET | Use this API to identify publishable services from a maintenances window. |
Identify publishable services from a ticketidentifyPublishableServicesTicket | GET | Use this API to identify publishable services from a ticket. |
List all incident statuseslistAllIncidentStatuses | GET | This operation allows the user to view the list of incident statuses. |
List all incidentsviewIncidents | GET | This operation allows the user to view the list of incidents. |
List all maintenance statuseslistAllMaintenanceStatuses | GET | This operation allows the user to view the list of maintenance statuses. |
List all maintenance updates from a changeviewMaintenanceUpdateFromChange | GET | This operation allows the user to view the list of updates posted to a maintenance via a change. |
List all maintenance updates from a maintenance windowviewMaintenanceUpdateFromMaintenanceWindow | GET | This operation allows the user to view the list of updates posted to a maintenance via a maintenance window. |
List all maintenancesviewMaintenances | GET | This operation allows the user to view the list of maintenances. |
List all service componentsviewServiceComponents | GET | This operation allows the user to view list of service components. |
List all status pagesviewStatusPages | GET | This operation allows the user to view all the status pages. |
List all subscriberslistAllSubscribers | GET | Use this API to view all subscribers associated with a specific status page. |
List all updates for an incidentviewIncidentUpdates | GET | This operation allows the user to view the list of incident updates. |
Update a maintenance from a changeupdateMaintenanceFromChange | PUT | This operation allows the user to update a maintenance from a change. |
Update a maintenance from a maintenance windowupdateMaintenanceFromMaintenanceWindow | PUT | This operation allows the user to update a maintenance from a maintenance window. |
Update a maintenance update from a changeupdateMaintenanceUpdateFromChange | PUT | This operation allows the user to edit an update posted to a maintenance from a change. |
Update a maintenance update from a maintenance windowupdateMaintenanceUpdateFromMaintenanceWindow | PUT | This operation allows the user to update a maintenance update from the maintenance window. |
Update a subscriberupdateSubscriber | PUT | Use this API to update the service subscription preferences for an existing subscriber. |
Update an incidentupdateIncident | PUT | This operation allows the user to update an incident. |
View a maintenance from a changeviewMaintenanceFromChange | GET | This operation allows the user to view the maintenance associated to the change. |
View a maintenance from a maintenance windowviewMaintenanceFromMaintenanceWindow | GET | This operation allows the user to view the maintenance associated to the change. |
View a service componentviewServiceComponent | GET | This operation allows the user to view a service component. |
View a subscriberviewASubscriber | GET | Use this API to view details of a subscriber associated with a specific status page. |
View an incidentviewIncident | GET | This operation allows the user to view an incident. |
Tickets45
Add Catalog Item to Existing Service RequestaddCatalogItemToExistingSr | POST | This API helps you add a new catalog item to an existing service request. |
Cancel an approvalcancelATicketApproval | PUT | Cancel 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 RequestcancelApprovalGroups | PUT | Cancel Approval Group in a Service Request |
Create a Child Service RequestcreateChildServiceRequest | POST | This 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 TicketcreateChildTicket | POST | This API lets you to create a new child ticket on an existing ticket Note: 1. |
Create a Service RequestcreateServiceRequest | POST | This 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 filescreateServiceRequestMultipart | POST | This API helps you create a service request Note 1: The service requested will be created with the requester specified in “email” attribute. |
Create a SourcecreateCustomTicketSource | POST | This API helps you create a new Ticket Source. |
Create a TaskcreateTicketTask | POST | Create a new task on a ticket request in freshservice |
Create a TicketcreateTicket | POST | This API helps you to create a new ticket in your service desk. |
Create a Ticket with filescreateTicketMultipart | POST | This API helps you to create a new ticket in your service desk. |
Create a Time EntrycreateTicketTimeEntry | POST | This API helps to create a Time Entry. |
Create Approval Groups for a Service RequestcreateApprovalGroups | POST | Create an Approval Group for a Service Request Note: "email content" is an optional parameter for sending approval. |
CSAT ResponseviewCsatResponse | GET | Retrieve a csat response of a Ticket with the given ID from Freshservice/Freshservice for Business Teams. |
Delete a TaskdeleteATicketTask | DELETE | Delete the task on a Ticket with the given ID from Freshservice/Freshservice for Business Teams. |
Delete a TicketdeleteTicket | DELETE | This API helps you delete a ticket. |
Delete a Ticket AttachmentdeleteATicketAttachment | DELETE | This API helps you delete an attachment from a ticket. |
Delete a Time EntrydeleteTicketTimeEntry | DELETE | This API can be used to delete an existing Time Entry. |
Demote an incident from a major incidentdemoteIncidentFromMajor | PUT | Demote a major incident back to a normal incident. |
Filter TicketsfilterTickets | GET | Custom 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 ActivitygetTicketActivities | GET | Retrieve recent ticket activity for any ticket using ticket ID. |
List all Ticket Approval GroupslistAllTicketApprovalGroups | GET | List all Approval Groups in the Service Request. |
List all Ticket ApprovalslistAllTicketApprovals | GET | Retrieve all approvals on a Service Request with the given ID from Freshservice/Freshservice for Business Teams. |
List all Ticket FieldsviewAllTicketFields | GET | Retrieve 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 TicketlistAllTicketTimeEntries | GET | This API helps to view all time entries of a particular ticket. |
Move a TicketmoveATicket | PUT | Freshservice/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 incidentpromoteIncidentToMajor | PUT | Promote an existing incident into a major incident. |
Request Approval for a Service RequestcreateTicketApproval | POST | Send a Service Request for approval Note: 1. |
Restore a TicketrestoreATicket | PUT | |
Send Reminder for an ApprovalresendReminderTicketApproval | PUT | Resends a reminder for a specific Approval raised for the ticket |
Update a TaskupdateATicketTask | PUT | Update an existing task on an existing Ticket in Freshservice |
Update a TicketupdateTicket | PUT | This API lets you make changes to the parameters of a ticket from updating statuses to changing ticket type. |
Update a Ticket with filesupdateTicketMultipart | PUT | This API lets you make changes to the parameters of a ticket from updating statuses to changing ticket type. |
Update a Time EntryupdateTicketTimeEntry | PUT | This API can be used to update/modify existing time entry. |
Update approval chain rule for a service requestupdateServiceRequestApprovalChainRule | PUT | Update chain rule for the approval groups in the service request. |
Update Approval Group In A Service RequestupdateApprovalGroups | PUT | Update Approval Group In A Service Request Note: "email content" is an optional parameter for sending approval. |
Update Requested Items of a Service RequestupdateReqItemsOfSr | PUT | This api helps you to update the requested items attached to a service request Note: 1. |
Update Requested Items of a Service Request with filesupdateReqItemsOfSrMultipart | PUT | This api helps you to update the requested items attached to a service request Note: 1. |
View a TaskviewATicketTask | GET | Retrieve a task on a Ticket with the given ID from Freshservice |
View a TicketgetTicket | GET | Use 'include' to embed additional details in the response. |
View a Time EntryviewTicketTimeEntry | GET | This API call helps to list a particular Time Entry. |
View all TasksviewAllTicketTasks | GET | Retrieve the tasks on a Ticket with the given ID from Freshservice. |
View an ApprovalviewATicketApproval | GET | Retrieve an approval on a Service Request with the given ID from Freshservice |
View List of TicketslistTickets | GET | Use filters to view only specific tickets (those which match the criteria that you choose). |
View Requested Items of a Service RequestviewReqItemsOfSr | GET | This api helps you to view requested items attached to a service request |
Vendors5
Create a VendorcreateAVendor | POST | This operation allows you to create a vendor. |
Delete a VendordeleteAVendor | DELETE | This operation allows you to delete a vendor. |
List all VendorsviewAllVendors | GET | This operation allows you to view information about all vendors in the account. |
Update a VendorupdateAVendor | PUT | This operation allows you to update a vendor. |
View a VendorviewAVendor | GET | This operation allows you to view a particular vendor. |
Workspaces7
Create ClientcreateClient | POST | You cannot create a client with workspace id = 1 (Global), 2 (Default Client) and 3 (MSP Client) as these are system generated. |
Delete a ClientdeleteAClient | DELETE | Cannot delete client with id = 1,2 and 3 as these are reserved for internal purposes |
Filter ClientsfilterClients | GET | Note: 1. |
List All Client FieldslistAllClientFields | GET | Retrieve all the Fields that constitute the Client Object. |
List All Workspaces / ClientsviewAllWorkspaces | GET | Retrieves information about all the workspaces created in the account |
Update a ClientupdateAClient | PUT | You cannot update clients with workspace id = 1 (Global), 2 (Default Client). |
View a Workspace / ClientviewAWorkspace | GET | Retrieves information about a particular workspace in the account |