Service Desk API for Developers

API REFERENCE

Introduction
- Introduction
- What's New?
- Rate limit
- Policies
- Changelog
- Authentication
- Schema
- Embedding
- Attachments
- Errors
- Pagination
- Best Practices
- API Index
Tickets
- Tickets
- Create a Ticket
- View a Ticket
- Filter Tickets
- View List of Tickets
- Update a Ticket
- Move a Ticket
- Delete a Ticket
- Delete a Ticket Attachment
- Restore a Ticket
- Create a Child Ticket
- List All Ticket Fields
- Get Ticket Activity
- Time Entries
- Create a Time Entry
- View a Time Entry
- List All Time Entries of a Ticket
- Update a Time Entry
- Delete a Time Entry
- Create a Source
- Service Request
- Create a Service Request
- Create a Child Service Request
- View Requested Items of a Service Request
- Update Requested Items of a Service Request
- Approvals
- Request Approval For A Service Request
- List All Ticket Approvals
- View An Approval
- Cancel An approval
- Send Reminder For An Approval
- Tasks
- Create a Task
- View a Task
- View all Tasks
- Update a Task
- Delete a Task
- CSAT
- CSAT Response
Conversations
- Conversations
- Create a Reply
- Create a Note
- Update a Conversation
- Delete a Conversation
- Delete a Conversation Attachment
- List All Conversations of a Ticket
Problems
- Problems
- Create a Problem
- View a Problem
- View List of Problems
- Update a Problem
- Move a Problem
- Delete a Problem
- Restore a Problem
- List All Problem Fields
- Notes
- Create a note
- View a note
- View all notes
- Update a note
- Delete a note
- Time Entries
- Create a Time Entry
- View a Time Entry
- List All Time Entries
- Update a Time Entry
- Delete a Time Entry
- Tasks
- Create a Task
- View a Task
- View all Tasks
- Update a Task
- Delete a Task
Changes
- Changes
- Create a Change
- View a Change
- View List of Changes
- Update a Change
- Move a Change
- Delete a Change
- Restore a Change
- List All Change Fields
- Notes
- Create a note
- View a note
- View all notes
- Update a note
- Delete a note
- Time Entries
- Create a Time Entry
- View a Time Entry
- List All Time Entries
- Update a Time Entry
- Delete a Time Entry
- Tasks
- Create a Task
- View a Task
- View all Tasks
- Update a Task
- Delete a Task
Releases
- Releases
- Create a Release
- View a Release
- Update a Release
- Move a Release
- Delete a Release
- Filter Releases
- View list of Releases
- Restore a Release
- View All Release Fields
- Notes
- Create a note
- View a note
- View all notes
- Update a note
- Delete a note
- Time Entries
- Create a Time Entry
- View a Time Entry
- List All Time Entries
- Update a Time Entry
- Delete a Time Entry
- Tasks
- Create a Task
- View a Task
- View all Tasks
- Update a Task
- Delete a Task
CABs
- CABs
- Create a CAB
- List All CABs
- View a CAB
- Update a CAB
- Delete a CAB
Workspaces
- Workspaces
- List All Workspaces
- View a Workspace
Approvals
- Approvals
- List All Approvals
Users (Requesters)
- Requesters
- Create a Requester
- View a Requester
- List All Requesters
- Filter Requesters
- List All Requester Fields
- Update a Requester
- Deactivate a Requester
- Forget a Requester
- Convert To Agent
- Merge Requesters
- Reactivate a Requester
- User Assignment History
Users (Agents)
- Agents
- Create an Agent
- View an Agent
- List All Agents
- Filter Agents
- Update an Agent
- Deactivate an Agent
- Forget an Agent
- Reactivate an Agent
- Convert To Requester
- List All Agent Fields
- User Assignment History
Agent Roles
- Agent Roles
- View a Role
- List All Roles
Agent Groups
- Agent Groups
- Create a Group
- View a Group
- List All Groups
- Update a Group
- Delete a Group
Requester Groups
- Requester Groups
- Create a Requester Group
- View a Requester Group
- List All Requester Groups
- Update a Requester Group
- Delete a Requester Group
- Add Requester to Requester Group
- Delete Requester from Requester Group
- List Requester Group Members
Locations
- Locations
- Create a Location
- View a Location
- List all Locations
- Filter Locations
- Update a Location
- Delete a Location
Products
- Products
- Create a Product
- View a Product
- List All Products
- Update a Product
- Delete a Product
Vendors
- Vendors
- Create a Vendor
- View a Vendor
- List All Vendors
- Update a Vendor
- Delete a Vendor
Alerts
- Alerts
- Alert Properties
- View an alert
- View Multiple Alerts using Filters
- View all Alert Logs
- Acknowledge an alert
- Resolve an alert
- Suppress an alert
- Unsuppress an alert
- Delete an Alert
- Notes
- Create an Alert Note
- View all alert notes
- View an alert note
- Update an alert note
- Delete an alert note
Assets
- Assets
- Asset Assignment History
- Create an Asset
- View an Asset
- View List of Assets
- Search Assets
- Filter Assets
- Update an Asset
- Delete an Asset
- Restore an Asset
- Delete an Asset Permanently
- Move an Asset
- List all Asset Components
- Create a Component
- Update a Component
- List All Associated Requests
- List all associated Contracts
- Create Relationships in bulk
- View a Relationship
- List all Relationships in the Account
- List all Relationships for an Asset
- Delete Relationships in bulk
- List all Relationship Types
Purchase Order
- Purchase Order
- Create a new Purchase Order
- List All Purchase Orders
- Move a Purchase Order
- View a Purchase Order
- Update a Purchase Order
- Delete a Purchase Order
Asset Types
- Asset Types
- Create an Asset Type
- View an Asset Type
- List all Asset Types
- Update an Asset Type
- Delete an Asset Type
- List all Fields of an Asset Type
Software
- Software
- Create a Software
- Update a Software
- View a Software
- List all Software
- List all Licenses
- Delete a Software
- Delete multiple Software
- Software Users
- Add Users to a Software in bulk
- View a Software User
- Move a Software
- List all Users of a Software
- Update Users of a Software in bulk
- Remove Users from a Software in bulk
- Software Installations
- Add a device to a Software
- List all installations of a Software
- Remove devices from a Software in bulk
- List all Relationships for a Software
Contracts
- Contracts
- List all contract types
- List all fields of a contract type
- View a contract
- List all contracts
- Move a Contract
- Create a Contract
- Create a Contract with associated assets
- Create a Contract with attachment
- Update a Contract
- Submit a contract for approval
- Approve a Contract
- Reject a Contract
- List all associated assets of a contract
- List all attachments of a contract
Departments
- Departments / Companies
- Create a Department
- View a Department
- List All Departments
- Filter Departments
- Update a Department
- Delete a Department
- List All Department Fields
Business Hours
- Business Hours
- View a Business Hours Configuration
- View List of Business Hours Configurations
Projects
- Projects (Legacy)
- Create a Project
- Update a Project
- View a Project
- List All Projects
- Delete a Project
- Archive a Project
- Restore a Project
Project Tasks
- Projects Tasks (Legacy)
- Create a Project Task
- Update a Project Task
- View a Project Task
- List All Project Tasks
- Delete a Project Task
Projects NewGen
- Projects
- Create a Project
- Update a Project
- View a Project
- List All Projects
- Delete a Project
- Archive a Project
- Restore a Project
- View Project Fields
- View Project Templates
- Add Members
- Create Associations
- View Associations
- Delete Association
- Delete Attachment of a Project
Project Tasks NewGen
- Projects Tasks
- Create a Project Task
- Update a Project Task
- View a Project Task
- List All Project Tasks
- Filter All Project Tasks
- Delete a Project Task
- View Project Task Type Fields
- View Project Task Types
- View Project Task Priorities
- View Project Task Statuses
- View Project Versions
- View Project Sprints
- View Project Memberships
- Create Associations
- View Associations
- Delete Association
- Create Note
- View Notes
- Update Note
- Delete Note
- Delete Attachment of a Note
- Delete Attachment of a Task
Solution Category
- Solution Category
- Create Solution Category
- Update Solution Category
- View Solution Category
- View List of Solution Categories
- Delete Solution Category
Solution Folder
- Solution Folder
- Create Solution Folder
- Create Solution Folder with Approval
- Update Solution Folder
- View Solution Folder
- View List of Solution Folder
- Delete Solution Folder
Solution Article
- Solution Article
- Create Solution Article
- Create Secondary Language Article
- Create Article With Attachment
- Create Article from External URL
- Search Solution Articles
- Send Article to Approval
- Publish Solution Article
- Update Solution Article
- View Solution Article
- View List of Solution Article
- Delete Solution Article
Service Catalog
- Service Catalog
- Service Item
- View a Service Item
- View List of Service Items
- Search Service Items
- Create Service Catalog item
- Service Category
- View List of Service Categories
Announcements
- Announcements
- Create an Announcement
- View an Announcement
- List All Announcements
- Edit an Announcement
- Delete an Announcement
Employee Onboarding
- Employee Onboarding
- View Onboarding Form Fields
- Create an Onboarding Request
- View an Onboarding Request
- View all Onboarding Requests
- View Onboarding Tickets
Employee Offboarding
- Employee Offboarding
- View Offboarding Form Fields
- Create an Offboarding Request
- View an Offboarding Request
- View all Offboarding Requests
- View Offboarding Tickets
Oncall management
- Oncall management
- Create a schedule
- Update a schedule
- View all schedules
- Filter schedules
- View a schedule
- Delete a schedule
- Create a shift
- Update a shift
- View all shifts
- View a shift
- Delete a shift
- Create/Update/Delete an override
- View oncall calendar events for a user
- View oncall calendar events for a schedule
- View oncall calendar events for a shift
- View oncall calendar events of a shift for a user
- View oncall calendar events of a schedule for a user
- Export oncall calendar events for a user
- Export oncall calendar events for a schedule
- Export oncall calendar events for a shift
- Export oncall calendar events of a shift for a user
- Export oncall calendar events of a schedule for a user
- View who is oncall
- Create an escalation policy
- Update an escalation policy
- View all escalation policies
- View an escalation policy
- Delete an escalation policy
- Reorder an escalation policy
Custom Objects
- Custom Objects
- View List of Custom Objects
- Show a Custom Object
- Create new Custom Object Record
- List all records of a Custom Object
- Update Custom Object Record
- Delete Custom Object Record
SLA Policies
- SLA Policies
- View List of SLAs
Canned Responses
- Canned Response Folders
- View List of Canned Response Folders
- Show a Canned Response Folder
- List all Canned Responses In a Folder
- Canned Responses
- View List of Canned Responses
- Show a Canned Response
Audit Logs
- Audit Logs
- Audit Log Export
Attachment
- Attachment
- Download Attachment
- Download Purchase order and Contracts Attachment
Status page
- Status page
- Impacted Service Properties
- Incidents
- Incident properties
- List all incidents
- View an incident
- Create an incident
- Update an incident
- Delete an incident
- Incident Updates
- List all updates for an incident
- Create incident update
- Edit an incident update
- Delete an incident update
- Maintenance
- Maintenance properties
- List all maintenances
- Create a maintenance from a change
- Update a maintenance from a change
- View a maintenance from a change
- Delete a maintenance from a change
- Create a maintenance from a maintenance window
- Update a maintenance from a maintenance window
- View a maintenance from a maintenance window
- Delete a maintenance from a maintenance window
- Maintenance Updates
- Create a maintenance update from a change
- Update a maintenance update from a change
- List all maintenance updates from a change
- Delete a maintenance update from a change
- Create a maintenance update from a maintenance window
- Update a maintenance update from a maintenance window
- List all maintenance updates from a maintenance window
- Delete a maintenance update from a maintenance window
- List all status pages
- View a service component
- List all service components