| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://yourdomain.freshservice.com/api/v2 | link | — | — | — |
Actions (96)
Ticket · 13
- Add note to ticket (private/public)POST /helpdesk/tickets/[ticket_id]/conversations/note.json
Add a note to a ticket; can be public or private depending on request.
documented - Associate CI/Asset to a TicketPOST /helpdesk/tickets.json
Associate an asset/CI to a ticket at creation or via related payload (documented in v1).
documented - Create ticketPOST /helpdesk/tickets.json
Create a new ticket in the service desk.
documented - Delete ticketDELETE /helpdesk/tickets/[id].json
Delete a ticket.
documented - Get all ticket fieldsGET /helpdesk/ticket_fields.json
Retrieve all fields defined for tickets.
documented - List ticketsGET /helpdesk/tickets.json
View tickets in your service desk (paginated).
documented - List tickets by filterGET /helpdesk/tickets/filter/[filter_name]?format=json
List tickets matching a pre-defined filter (e.g., all_tickets, new_my_open, monitored_by, spam, deleted).
documented - List tickets by requesterGET /helpdesk/tickets/filter/requester/[requester_id]?format=json
List tickets associated with a specific requester.
documented - List tickets by requester emailGET /helpdesk/tickets.json?email=[email]&filter_name=all_tickets
List tickets for a requester identified by email.
documented - Update ticketPUT /helpdesk/tickets/[id].json
Update a ticket.
documented - Update ticketPUT /helpdesk/tickets/[id].json
Update properties of an existing ticket.
documented - View ticketGET /helpdesk/tickets/[id].json
Retrieve a specific ticket and its conversations.
documented - View ticket by viewGET /helpdesk/tickets/view/[view_id]?format=json
View tickets using a saved view.
documented
Asset · 7
- Create AssetPOST /cmdb/items.json
Create an asset (CI).
documented - Delete AssetDELETE /cmdb/items/[id].json
Delete an asset.
documented - List AssetsGET /cmdb/items.json
List assets.
documented - Restore AssetPUT /cmdb/items/[id]/restore.json
Restore a soft-deleted asset.
documented - Search AssetsGET /cmdb/items/list.json?field=[field_param]&q=[query_param]
Search assets by field and query.
documented - Update AssetPUT /cmdb/items/[id].json
Update an asset.
documented - View AssetGET /cmdb/items/[id].json
View a single asset.
documented
Change · 7
- Add Note to ChangePOST /itil/changes/[id]/notes.json
Add a note to a change.
documented - Create ChangePOST /itil/changes.json
Create a change record.
documented - Delete ChangeDELETE /itil/changes/[id].json
Delete a change.
documented - Detach Asset from ChangePUT /itil/changes/[id]/detach_ci.json
Detach assets from a change.
documented - List ChangesGET /itil/changes.json
List changes.
documented - Update ChangePUT /itil/changes/[id].json
Update a change.
documented - View ChangeGET /itil/changes/[id].json
Retrieve a change.
documented
Problem · 7
- Add Note to ProblemPOST /itil/problems/[id]/notes.json
Add a note to a problem.
documented - Create ProblemPOST /itil/problems.json
Create a new problem record.
documented - Delete ProblemDELETE /itil/problems/[id].json
Delete a problem.
documented - Detach Asset from ProblemPUT /itil/problems/[id]/detach_ci.json
Detach assets from a problem.
documented - List ProblemsGET /itil/problems.json
List problems in the system.
documented - Update ProblemPUT /itil/problems/[id].json
Update a problem.
documented - View ProblemGET /itil/problems/[id].json
Retrieve a specific problem.
documented
Release · 7
- Add Note to ReleasePOST /itil/releases/[id]/notes.json
Add a note to a release.
documented - Create ReleasePOST /itil/releases.json
Create a release.
documented - Delete ReleaseDELETE /itil/releases/[id].json
Delete a release.
documented - Detach Asset from ReleasePUT /itil/releases/[id]/detach_ci.json
Detach assets from a release.
documented - List ReleasesGET /itil/releases.json
List releases.
documented - Update ReleasePUT /itil/releases/[id].json
Update a release.
documented - View ReleaseGET /itil/releases/[id].json
View a release.
documented
Service Catalog · 6
- Legacy workflow integration (note)GET /workflow-legacy-glue
Reference to legacy workflow integration pathways.
documented - List Service Categories (pagination)GET /catalog/categories.json?page=1
Paginated list of service categories.
documented - List Service ItemsGET /catalog/items.json
List all service items.
documented - View all service categoriesGET /catalog/categories.json
List all service categories.
documented - View items in a categoryGET /catalog/categories/[category_id]/items.json
List all service items in a given category.
documented - View service itemGET /catalog/items/[display_id].json
View details for a service item.
documented
Solution Article · 6
- Create Solution ArticlePOST /solution/categories/[id]/folders/[id]/articles.json
Create a knowledge base article in a folder.
documented - Delete Solution ArticleDELETE /solution/categories/[id]/folders/[id]/articles/[id].json
Delete a knowledge base article.
documented - List Solution ArticlesGET /solution/categories/[id]/folders/[id]/articles.json
List articles in a folder.
documented - Update Solution ArticlePUT /solution/categories/[id]/folders/[id]/articles/[id].json
Update a knowledge base article.
documented - View Solution ArticleGET /solution/categories/[id]/folders/[id]/articles/[id].json
View a knowledge base article.
documented - View Solution ArticleGET /solution/categories/[id]/folders/[id]/articles/[id].json
View a knowledge base article.
documented
Tasks · 6
- Create TaskPOST /itil/{module_name}/{module_item_id}/it_tasks.json
Create a task under a module item.
documented - List All TasksGET /itil/it_tasks.json
List all tasks.
documented - List TasksGET /itil/{module_name}/{module_item_id}/it_tasks.json
List tasks for a module item.
documented - List Tasks by TicketGET /itil/tickets/[ticket_id]/it_tasks.json
List tasks for a specific ticket.
documented - Update TaskPUT /itil/{module_name}/{module_item_id}/it_tasks/{task_id}.json
Update a specific task.
documented - View TaskGET /itil/{module_name}/{module_item_id}/it_tasks/{task_id}.json
View a specific task.
documented
Contracts · 5
- Create ContractPOST /cmdb/contracts.json
Create a contract.
documented - Delete ContractDELETE /cmdb/contracts/[id].json
Delete a contract.
documented - List ContractsGET /cmdb/contracts.json
List contracts.
documented - Update ContractPUT /cmdb/contracts/[id].json
Update a contract.
documented - View ContractGET /cmdb/contracts/[id].json
View a contract.
documented
Department · 5
- Create DepartmentPOST /itil/departments.json
Create a department.
documented - Delete DepartmentDELETE /itil/departments/[id].json
Delete a department.
documented - List DepartmentsGET /itil/departments.json
List departments.
documented - Update DepartmentPUT /itil/departments/[id].json
Update a department.
documented - View DepartmentGET /itil/departments/[id].json
View a department.
documented
Solution Category · 5
- Create Solution CategoryPOST /solution/categories.json
Create a solution category.
documented - Delete Solution CategoryDELETE /solution/categories/[id].json
Delete a solution category.
documented - List Solution CategoriesGET /solution/categories.json
List solution categories.
documented - Update Solution CategoryPUT /solution/categories/[id].json
Update a solution category.
documented - View Solution CategoryGET /solution/categories/[id].json
View a solution category.
documented
Solution Folder · 5
- Create Solution FolderPOST /solution/categories/[id]/folders.json
Create a solution folder under a category.
documented - Delete Solution FolderDELETE /solution/categories/[id]/folders/[id].json
Delete a solution folder.
documented - List Solution FoldersGET /solution/categories/[id]/folders.json
List folders in a solution category.
documented - Update Solution FolderPUT /solution/categories/[id]/folders/[id].json
Update a solution folder.
documented - View Solution FolderGET /solution/categories/[id]/folders/[id].json
View a solution folder.
documented
Time Entries · 5
- Create Time EntryPOST /itil/tickets/[ticket_id]/time_sheets.json
Create a time entry for a ticket.
documented - Delete Time EntryDELETE /itil/tickets/[ticket_id]/time_sheets/[id].json
Delete a time entry.
documented - Start/Stop TimerPUT /itil/{module_name}/{module_item_id}/time_sheets/[id]/toggle_timer.json
Start or stop the time-tracking timer for a time entry.
documented - Update Time EntryPUT /itil/{module_name}/{module_item_id}/time_sheets/[id].json
Update the time entry.
documented - View Time Entries by ModuleGET /itil/{module_name}/{module_item_id}/time_sheets.json
View time entries for a given module item.
documented
User · 5
- Create UserPOST /itil/requesters.json
Create a new user (requester).
documented - Deactivate UserDELETE /itil/requesters/[id].json
Deactivate a user.
documented - List UsersGET /itil/requesters.json
List users.
documented - Update UserPUT /itil/requesters/[id].json
Update a user.
documented - View UserGET /itil/requesters/[id].json
View a user.
documented
Asset Relationships · 4
- Create Asset RelationshipPOST /cmdb/items/[id]/associate.json
Create a relationship for an asset.
documented - Delete Asset RelationshipDELETE /cmdb/items/[id]/detach_relationship.json
Delete a specific asset relationship.
documented - List Relationship TypesGET /cmdb/relationship_types/list.json
List all asset relationship types.
documented - View Asset RelationshipsGET /cmdb/items/[id]/relationships.json
View relationships of an asset.
documented