List all Tickets

List all Help Desk tickets by passing the person ID, account ID, and/or other parameters
Help Desk
List all Tickets
 last updated: 
November 30, 2023

When retrieving tickets, you'll need to pass the sd-api-key and sd-dashboard-user-email in the header.

ENDPOINT

  1. GET /v1/ticket

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
personId string person ID
accountId string account ID
transactionId string transaction ID
status enum open, pending, hold, solved, closed


RESPONSE

  1. {
  2.  "total": "7",
  3.  "data": [
  4.    {
  5.      "id": "18542",
  6.      "subject": "Message from Justin Testin",
  7.      "description": "testing the answer bot",
  8.      "status": "closed",
  9.      "type": "tasks",
  10.      "priority": "",
  11.      "canBeSolved": false,
  12.      "createdAt": "2022-06-28T22:51:41Z",
  13.      "modifiedAt": "2022-07-06T21:01:58Z",
  14.      "latestComment": null,
  15.      "cc": [],
  16.      "accountId": "acc-********-****-****-****-************",
  17.      "personId": "per-********-****-****-****-************",
  18.      "transactionId": "txn-********-****-****-****-************",
  19.      "mode": ""
  20.    },
  21.    {
  22.      "id": "15340",
  23.      "subject": "Testing updating a ticket via API",
  24.      "description": "Testing updating a ticket via API",
  25.      "status": "closed",
  26.      "type": "tasks",
  27.      "priority": "normal",
  28.      "canBeSolved": false,
  29.      "createdAt": "2022-06-16T22:09:07Z",
  30.      "modifiedAt": "2022-06-23T23:01:20Z",
  31.      "latestComment": null,
  32.      "cc": [],
  33.      "accountId": "",
  34.      "personId": "",
  35.      "mode": "test"
  36.    }
  37.  ]
  38. }