Ticket Search Endpoint

Obtain a list of tickets for your account based on the generic search.

GET //developer.livehelpnow.net/api/ticket/search

Query Params

Name Expected Type Description
search_term required string The search term you would like to use
start_index optional integer Set start index for result set
count optional integer Set the count/limit for page

Result

{
 "status": "ok",
 "payload": {
  "tickets": [
   {
    "id": 123456,
    "client_id": 123456,
    "name": "Jane Doe",
    "email": "j.dow@email.com",
    "body": "Ticket Body",
    "created_time": "2019-01-01T12:00:00",
    "updated_time": "2019-01-01T12:00:00",
    "country_code": "US",
    "priority": "Important",
    "assigned_to": 1234,
    "assigned_to_name": "Operator Name",
    "title": "Ticket Title",
    "category": "Tech Support",
    "has_attachments": true,
    "acknowledged": "Acknowledged",
    "status": "Open",
    "source": "Twitter",
    "visitor_id": "XXXX-XXXXX-XX-XXXX",
    "tags": [
     "Tag1", "Tag2", etc
    ]
   },
   ...
  ],
  "total_rows": 10,
  "count": 10,
  "start_index": 1
 }
}

tickets array The list of tickets
 id string A unique identifier for the ticket
 client_id string The client identifier for the ticket
 name string The name for the customer who submitted the ticket
 email string The email address for the customer who submitted the ticket
 body string The ticket body
 created_time string The time the ticket was created
 updated_time string The time the ticket was last updated
 country_code string The country code for the ticket/visitor
 priority string The ticket priority
 assigned_to integer The id of the operator who assigned to the ticket
 assigned_to_name string The name of the operator who assigned to the ticket
 title string The title of the ticket
 category string The category of the ticket
 has_attachments boolean If the ticket has attachments associated with it
 acknowledged string The acknowledge state of the ticket (Acknowledged or Unacknowledged)
 status string The current status of the ticket
  • Open
  • Response Received
  • Comment Added
  • Working
  • Waiting for Response
  • Closed
 source string The source of the ticket
  • Form
  • Email to Ticket
  • Twitter
 visitor_id string The unique identifier for the visitor associated with the ticket
 tags array A list of tags associated with the ticket
total_rows integer The total number of tickets matched
count integer The number of tickets returned within the payload
start_index integer The start index for the current tickets within the payload