ManageEngine ServiceDesk Plus

App · 20 actions

IT help desk. Raise, update and close requests, add notes, tasks and time logs, and find requests by status, priority or group.

Actions

ActionWhat it does
Add noteAdd a note to a request.
Add worklogLog time spent on a request.
Close requestClose a request.
Create requestRaise a request (ticket).
Create taskAdd a task to a request.
Delete noteDelete a note from a request.
Delete requestDelete a request.
Delete taskDelete a task from a request.
Delete worklogDelete a worklog from a request.
Get noteGet one note on a request.
Get requestGet one request: its subject, status, people, dates and resolution.
Get taskGet one task on a request.
List closure codesList the closure codes a request can be closed with.
List notesList the notes on a request, oldest first.
List requestsList requests, newest first, optionally only those whose subject contains some text or that have a given status, priority or group.
List tasksList the tasks on a request, oldest first.
List worklogsList the time logged on a request, oldest first.
Update noteChange a note's text or who can see it.
Update requestChange fields on a request.
Update taskChange a task.

Add note

Add a note to a request. It is private to technicians unless you show it to the requester.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
NotedescriptiontextRequired
What to write.
Show to requestershow_to_requestertrue/false
Whether the requester can see the note. Off keeps it private to technicians.
Notify techniciannotify_techniciantrue/false
Whether to tell the request's technician about the note.

Outputs

noteobject
The new note
Example output
{
  "note": {
    "created_by_email": "charles@example.com",
    "created_by_id": "1994035670863379",
    "created_by_name": "Charles",
    "created_time": "2026-10-20T10:00:00.000Z",
    "description": "<div>Called the requester; monitor ordered.</div>",
    "id": "1997129173325228",
    "notify_technician": false,
    "request_id": "2079997951635005",
    "show_to_requester": false
  }
}

Add worklog

Log time spent on a request. The time spent is worked out from the start and end.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
TechnicianownertextRequired
Who did the work, by email address.
Startedstart_timedate and timeRequired
When the work started.
Endedend_timedate and timeRequired
When the work ended. Must be after it started.
Descriptiondescriptiontext
What was done.

Outputs

worklogobject
The new worklog
Example output
{
  "worklog": {
    "created_time": "2026-10-21T10:31:00.000Z",
    "description": "Set up the monitor",
    "end_time": "2026-10-21T10:30:00.000Z",
    "hours_spent": 1,
    "id": "2000000040351",
    "minutes_spent": 30,
    "owner_email": "charles@example.com",
    "owner_id": "1537931074919595",
    "owner_name": "Charles",
    "start_time": "2026-10-21T09:00:00.000Z"
  }
}

Close request

Close a request. Your portal may insist on a resolution or a closure code before it lets a request close.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Closure codeclosure_codetext
Why it is closed, such as Success.
Closure commentsclosure_commentstext
A note on why the request is closed.
Resolutionresolutiontext
The resolution text, saved on the request.

Outputs

requestobject
The closed request
Example output
{
  "request": {
    "category": "Hardware",
    "completed_time": null,
    "created_time": "2026-10-20T09:00:00.000Z",
    "description": "<div>Provide me an External Monitor</div>",
    "display_id": "39",
    "due_by_time": "2026-10-27T09:00:00.000Z",
    "group": "Hardware Problems",
    "has_notes": false,
    "id": "2079997951635005",
    "impact": "Affects Business",
    "is_overdue": false,
    "is_service_request": false,
    "item": null,
    "last_updated_time": "2026-10-20T09:00:00.000Z",
    "level": "Tier 1",
    "mode": "Web Form",
    "priority": "High",
    "request_type": "Service Request",
    "requester_email": "lincoln@example.com",
    "requester_id": "1650986973829395",
    "requester_name": "Lincoln",
    "resolution": null,
    "resolved_time": null,
    "site": null,
    "status": "Closed",
    "subcategory": null,
    "subject": "Need an External Monitor",
    "technician_email": "charles@example.com",
    "technician_id": "1537931074919595",
    "technician_name": "Charles",
    "urgency": "Urgent"
  }
}

Create request

Raise a request (ticket). Only the subject is required; ServiceDesk Plus fills in the rest from its defaults.

Inputs

SubjectsubjecttextRequired
One line saying what the request is about.
Descriptiondescriptiontext
The details of the request.
Requesterrequestertext
Who the request is for, by email address. Leave empty for the connected user.
Statusstatustext
The status, such as Open. Pick one or type its name.
Priorityprioritytext
The priority.
Urgencyurgencytext
The urgency.
Impactimpacttext
The impact.
Typerequest_typetext
The type, such as Incident or Service Request.
Modemodetext
How the request was raised, such as E-Mail.
Levelleveltext
The support level, such as Tier 1.
Categorycategorytext
The category.
Subcategorysubcategorytext
The subcategory, typed as named in ServiceDesk Plus. It must belong to the category.
Itemitemtext
The item, typed as named in ServiceDesk Plus. It must belong to the subcategory.
Groupgrouptext
The support group to assign it to.
Techniciantechniciantext
The technician to assign it to, by email address.
Due datedue_by_timedate and time
When the request is due.

Outputs

requestobject
The new request
Example output
{
  "request": {
    "category": "Hardware",
    "completed_time": null,
    "created_time": "2026-10-20T09:00:00.000Z",
    "description": "<div>Provide me an External Monitor</div>",
    "display_id": "39",
    "due_by_time": "2026-10-27T09:00:00.000Z",
    "group": "Hardware Problems",
    "has_notes": false,
    "id": "2079997951635005",
    "impact": "Affects Business",
    "is_overdue": false,
    "is_service_request": false,
    "item": null,
    "last_updated_time": "2026-10-20T09:00:00.000Z",
    "level": "Tier 1",
    "mode": "Web Form",
    "priority": "High",
    "request_type": "Service Request",
    "requester_email": "lincoln@example.com",
    "requester_id": "1650986973829395",
    "requester_name": "Lincoln",
    "resolution": null,
    "resolved_time": null,
    "site": null,
    "status": "Open",
    "subcategory": null,
    "subject": "Need an External Monitor",
    "technician_email": "charles@example.com",
    "technician_id": "1537931074919595",
    "technician_name": "Charles",
    "urgency": "Urgent"
  }
}

Create task

Add a task to a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
TitletitletextRequired
What the task is.
Descriptiondescriptiontext
The details of the task.
Ownerownertext
Who does the task, by email address.
Statusstatustext
The task's status, such as Open.
Priorityprioritytext
The task's priority.
Scheduled startscheduled_start_timedate and time
When the task is scheduled to start.
Scheduled endscheduled_end_timedate and time
When the task is scheduled to end.

Outputs

taskobject
The new task
Example output
{
  "task": {
    "created_time": "2026-10-20T10:30:00.000Z",
    "description": null,
    "id": "2174353095375675",
    "owner_email": "charles@example.com",
    "owner_id": "1537931074919595",
    "owner_name": "Charles",
    "percentage_completion": 0,
    "priority": "High",
    "request_id": "2079997951635005",
    "scheduled_end_time": "2026-10-22T09:00:00.000Z",
    "scheduled_start_time": "2026-10-21T09:00:00.000Z",
    "status": "Open",
    "title": "Order the monitor"
  }
}

Delete note

Delete a note from a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Note IDnote_idtextRequired
The note's id, from 'Add note' or 'List notes'.

Outputs

deletedtrue/false
Always true once deleted
note_idtext
The note deleted
Example output
{
  "deleted": true,
  "note_id": "1997129173325228"
}

Delete request

Delete a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.

Outputs

deletedtrue/false
Always true once deleted
request_idtext
The request deleted
Example output
{
  "deleted": true,
  "request_id": "2079997951635005"
}

Delete task

Delete a task from a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Task IDtask_idtextRequired
The task's id, from 'Create task' or 'List tasks'.

Outputs

deletedtrue/false
Always true once deleted
task_idtext
The task deleted
Example output
{
  "deleted": true,
  "task_id": "2174353095375675"
}

Delete worklog

Delete a worklog from a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Worklog IDworklog_idtextRequired
The worklog's id, from 'Add worklog' or 'List worklogs'.

Outputs

deletedtrue/false
Always true once deleted
worklog_idtext
The worklog deleted
Example output
{
  "deleted": true,
  "worklog_id": "2000000040351"
}

Get note

Get one note on a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Note IDnote_idtextRequired
The note's id, from 'Add note' or 'List notes'.

Outputs

noteobject
The note
Example output
{
  "note": {
    "created_by_email": "charles@example.com",
    "created_by_id": "1994035670863379",
    "created_by_name": "Charles",
    "created_time": "2026-10-20T10:00:00.000Z",
    "description": "<div>Called the requester; monitor ordered.</div>",
    "id": "1997129173325228",
    "notify_technician": false,
    "request_id": "2079997951635005",
    "show_to_requester": false
  }
}

Get request

Get one request: its subject, status, people, dates and resolution.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.

Outputs

requestobject
The request
Example output
{
  "request": {
    "category": "Hardware",
    "completed_time": null,
    "created_time": "2026-10-20T09:00:00.000Z",
    "description": "<div>Provide me an External Monitor</div>",
    "display_id": "39",
    "due_by_time": "2026-10-27T09:00:00.000Z",
    "group": "Hardware Problems",
    "has_notes": false,
    "id": "2079997951635005",
    "impact": "Affects Business",
    "is_overdue": false,
    "is_service_request": false,
    "item": null,
    "last_updated_time": "2026-10-20T09:00:00.000Z",
    "level": "Tier 1",
    "mode": "Web Form",
    "priority": "High",
    "request_type": "Service Request",
    "requester_email": "lincoln@example.com",
    "requester_id": "1650986973829395",
    "requester_name": "Lincoln",
    "resolution": null,
    "resolved_time": null,
    "site": null,
    "status": "Open",
    "subcategory": null,
    "subject": "Need an External Monitor",
    "technician_email": "charles@example.com",
    "technician_id": "1537931074919595",
    "technician_name": "Charles",
    "urgency": "Urgent"
  }
}

Get task

Get one task on a request.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Task IDtask_idtextRequired
The task's id, from 'Create task' or 'List tasks'.

Outputs

taskobject
The task
Example output
{
  "task": {
    "created_time": "2026-10-20T10:30:00.000Z",
    "description": null,
    "id": "2174353095375675",
    "owner_email": "charles@example.com",
    "owner_id": "1537931074919595",
    "owner_name": "Charles",
    "percentage_completion": 0,
    "priority": "High",
    "request_id": "2079997951635005",
    "scheduled_end_time": "2026-10-22T09:00:00.000Z",
    "scheduled_start_time": "2026-10-21T09:00:00.000Z",
    "status": "Open",
    "title": "Order the monitor"
  }
}

List closure codes

List the closure codes a request can be closed with.

Inputs

None.

Outputs

closure_codeslist
The closure codes
countnumber
How many
Example output
{
  "closure_codes": [
    {
      "id": "2000000008001",
      "name": "Success"
    }
  ],
  "count": 1
}

List notes

List the notes on a request, oldest first. Returns one page.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Start indexstart_indexnumber
Where to start, to get a later page. Use 'next_start_index' from the page before. Defaults to 1.At least 1.

Outputs

countnumber
How many came back in this page
has_moretrue/false
Whether there are more after this page
next_start_indexnumber
Give this as 'Start index' to get the next page
noteslist
The notes
Example output
{
  "count": 1,
  "has_more": false,
  "next_start_index": null,
  "notes": [
    {
      "created_by_email": "charles@example.com",
      "created_by_id": "1994035670863379",
      "created_by_name": "Charles",
      "created_time": "2026-10-20T10:00:00.000Z",
      "description": "<div>Called the requester; monitor ordered.</div>",
      "id": "1997129173325228",
      "notify_technician": false,
      "request_id": "2079997951635005",
      "show_to_requester": false
    }
  ]
}

List requests

List requests, newest first, optionally only those whose subject contains some text or that have a given status, priority or group. Gets one page; to see more, run it again with the next page it gives.

Inputs

Subject containssubject_containstext
Only requests whose subject contains this text.
Statusstatustext
Only requests with this status.
Priorityprioritytext
Only requests with this priority.
Groupgrouptext
Only requests assigned to this group.
Sort bysort_bytext
What to order the requests by.One of: created_time (Date created (default)), last_updated_time (Date last updated), due_by_time (Due date), subject, id. Default: created_time.
Ordersort_ordertext
Which end to start from.One of: desc (Newest first (default)), asc (Oldest first). Default: desc.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Start indexstart_indexnumber
Where to start, to get a later page. Use 'next_start_index' from the page before. Defaults to 1.At least 1.

Outputs

countnumber
How many came back in this page
has_moretrue/false
Whether there are more after this page
next_start_indexnumber
Give this as 'Start index' to get the next page
requestslist
The requests
Example output
{
  "count": 1,
  "has_more": false,
  "next_start_index": null,
  "requests": [
    {
      "category": "Hardware",
      "completed_time": null,
      "created_time": "2026-10-20T09:00:00.000Z",
      "description": "<div>Provide me an External Monitor</div>",
      "display_id": "39",
      "due_by_time": "2026-10-27T09:00:00.000Z",
      "group": "Hardware Problems",
      "has_notes": false,
      "id": "2079997951635005",
      "impact": "Affects Business",
      "is_overdue": false,
      "is_service_request": false,
      "item": null,
      "last_updated_time": "2026-10-20T09:00:00.000Z",
      "level": "Tier 1",
      "mode": "Web Form",
      "priority": "High",
      "request_type": "Service Request",
      "requester_email": "lincoln@example.com",
      "requester_id": "1650986973829395",
      "requester_name": "Lincoln",
      "resolution": null,
      "resolved_time": null,
      "site": null,
      "status": "Open",
      "subcategory": null,
      "subject": "Need an External Monitor",
      "technician_email": "charles@example.com",
      "technician_id": "1537931074919595",
      "technician_name": "Charles",
      "urgency": "Urgent"
    }
  ]
}

List tasks

List the tasks on a request, oldest first. Returns one page.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Start indexstart_indexnumber
Where to start, to get a later page. Use 'next_start_index' from the page before. Defaults to 1.At least 1.

Outputs

countnumber
How many came back in this page
has_moretrue/false
Whether there are more after this page
next_start_indexnumber
Give this as 'Start index' to get the next page
taskslist
The tasks
Example output
{
  "count": 1,
  "has_more": false,
  "next_start_index": null,
  "tasks": [
    {
      "created_time": "2026-10-20T10:30:00.000Z",
      "description": null,
      "id": "2174353095375675",
      "owner_email": "charles@example.com",
      "owner_id": "1537931074919595",
      "owner_name": "Charles",
      "percentage_completion": 0,
      "priority": "High",
      "request_id": "2079997951635005",
      "scheduled_end_time": "2026-10-22T09:00:00.000Z",
      "scheduled_start_time": "2026-10-21T09:00:00.000Z",
      "status": "Open",
      "title": "Order the monitor"
    }
  ]
}

List worklogs

List the time logged on a request, oldest first. Returns one page.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Start indexstart_indexnumber
Where to start, to get a later page. Use 'next_start_index' from the page before. Defaults to 1.At least 1.

Outputs

countnumber
How many came back in this page
has_moretrue/false
Whether there are more after this page
next_start_indexnumber
Give this as 'Start index' to get the next page
worklogslist
The worklogs
Example output
{
  "count": 1,
  "has_more": false,
  "next_start_index": null,
  "worklogs": [
    {
      "created_time": "2026-10-21T10:31:00.000Z",
      "description": "Set up the monitor",
      "end_time": "2026-10-21T10:30:00.000Z",
      "hours_spent": 1,
      "id": "2000000040351",
      "minutes_spent": 30,
      "owner_email": "charles@example.com",
      "owner_id": "1537931074919595",
      "owner_name": "Charles",
      "start_time": "2026-10-21T09:00:00.000Z"
    }
  ]
}

Update note

Change a note's text or who can see it. Only the fields you fill in change.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Note IDnote_idtextRequired
The note's id, from 'Add note' or 'List notes'.
Notedescriptiontext
The new text. Leave empty to keep it.
Show to requestershow_to_requestertrue/false
Whether the requester can see the note. Off keeps it private to technicians.
Notify techniciannotify_techniciantrue/false
Whether to tell the request's technician about the note.

Outputs

noteobject
The note as saved
Example output
{
  "note": {
    "created_by_email": "charles@example.com",
    "created_by_id": "1994035670863379",
    "created_by_name": "Charles",
    "created_time": "2026-10-20T10:00:00.000Z",
    "description": "<div>Called the requester; monitor ordered.</div>",
    "id": "1997129173325228",
    "notify_technician": false,
    "request_id": "2079997951635005",
    "show_to_requester": false
  }
}

Update request

Change fields on a request. Only the fields you fill in change.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Subjectsubjecttext
A new subject. Leave empty to keep it.
Descriptiondescriptiontext
The details of the request.
Requesterrequestertext
Who the request is for, by email address. Leave empty for the connected user.
Statusstatustext
The status, such as Open. Pick one or type its name.
Priorityprioritytext
The priority.
Urgencyurgencytext
The urgency.
Impactimpacttext
The impact.
Typerequest_typetext
The type, such as Incident or Service Request.
Modemodetext
How the request was raised, such as E-Mail.
Levelleveltext
The support level, such as Tier 1.
Categorycategorytext
The category.
Subcategorysubcategorytext
The subcategory, typed as named in ServiceDesk Plus. It must belong to the category.
Itemitemtext
The item, typed as named in ServiceDesk Plus. It must belong to the subcategory.
Groupgrouptext
The support group to assign it to.
Techniciantechniciantext
The technician to assign it to, by email address.
Due datedue_by_timedate and time
When the request is due.
Resolutionresolutiontext
The resolution text, saved on the request.

Outputs

requestobject
The request as saved
Example output
{
  "request": {
    "category": "Hardware",
    "completed_time": null,
    "created_time": "2026-10-20T09:00:00.000Z",
    "description": "<div>Provide me an External Monitor</div>",
    "display_id": "39",
    "due_by_time": "2026-10-27T09:00:00.000Z",
    "group": "Hardware Problems",
    "has_notes": false,
    "id": "2079997951635005",
    "impact": "Affects Business",
    "is_overdue": false,
    "is_service_request": false,
    "item": null,
    "last_updated_time": "2026-10-20T09:00:00.000Z",
    "level": "Tier 1",
    "mode": "Web Form",
    "priority": "High",
    "request_type": "Service Request",
    "requester_email": "lincoln@example.com",
    "requester_id": "1650986973829395",
    "requester_name": "Lincoln",
    "resolution": null,
    "resolved_time": null,
    "site": null,
    "status": "Open",
    "subcategory": null,
    "subject": "Need an External Monitor",
    "technician_email": "charles@example.com",
    "technician_id": "1537931074919595",
    "technician_name": "Charles",
    "urgency": "Urgent"
  }
}

Update task

Change a task. Only the fields you fill in change.

Inputs

Request IDrequest_idtextRequired
The request's id: the long number from 'Create request' or 'List requests', or the request's address in ServiceDesk Plus. It is not the short request number shown on screen.
Task IDtask_idtextRequired
The task's id, from 'Create task' or 'List tasks'.
Titletitletext
What the task is.
Descriptiondescriptiontext
The details of the task.
Ownerownertext
Who does the task, by email address.
Statusstatustext
The task's status, such as Open.
Priorityprioritytext
The task's priority.
Scheduled startscheduled_start_timedate and time
When the task is scheduled to start.
Scheduled endscheduled_end_timedate and time
When the task is scheduled to end.
Percentage completepercentage_completionnumber
How much of the task is done, 0 to 100.From 0 to 100.

Outputs

taskobject
The task as saved
Example output
{
  "task": {
    "created_time": "2026-10-20T10:30:00.000Z",
    "description": null,
    "id": "2174353095375675",
    "owner_email": "charles@example.com",
    "owner_id": "1537931074919595",
    "owner_name": "Charles",
    "percentage_completion": 0,
    "priority": "High",
    "request_id": "2079997951635005",
    "scheduled_end_time": "2026-10-22T09:00:00.000Z",
    "scheduled_start_time": "2026-10-21T09:00:00.000Z",
    "status": "Open",
    "title": "Order the monitor"
  }
}

On this page