GET
/api/ticket/search
Get a list of tickets for your account based on the generic search
Scope:
client
or
operator
Request Parameters
Query
search_term
required
The search term you would like to use
start_index
optional
Set start index for result set
count
optional
Set the count/limit for page
Response
Schema
payload
The ticket search data
count
The number of tickets returned within the payload
start_index
The start index for the current tickets within the payload
tickets
The list of tickets
acknowledged
The acknowledge state of the ticket (Acknowledged or Unacknowledged)
assigned_to
The id of the operator who assigned to the ticket
assigned_to_name
The name of the operator who assigned to the ticket
body
The ticket body
category
The category of the ticket
client_id
The client identifier for the ticket
country_code
The country code for the ticket/visitor
created_time
The time the ticket was created
The email address for the customer who submitted the ticket
has_attachments
If the ticket has attachments associated with it
id
A unique identifier for the ticket
name
The name for the customer who submitted the ticket
priority
The ticket priority
source
The source of the ticket
- Form
- Email to Ticket
status
The current status of the ticket
- Open
- Response Received
- Comment Added
- Working
- Waiting for Response
- Closed
tags
A list of tags associated with the ticket
The tag names
title
The title of the ticket
updated_time
The time the ticket was last updated
visitor_id
The unique identifier for the visitor associated with the ticket
total_rows
The total number of tickets matched
status
The system response status. Will be ok or error
curl
example request
1
curl -H "Authorization: Bearer {{Oauth Token}}"
2
https://developer.livehelpnow.net/api/ticket/search\?search_term\=help
example response
1
{
2
"payload": {
3
"count"
: 20,
4
"start_index"
: 1,
5
"tickets": [{
6
"acknowledged"
: "Acknowledged",
7
"assigned_to"
: 1234,
8
"assigned_to_name"
: "John Smith",
9
"body"
: "",
10
"category"
: "Billing",
11
"client_id"
: 1,
12
"country_code"
: "US",
13
"created_time"
: "2020-05-21T14:50:43",
14
"email"
: "jdoe@livehelpnow.com",
15
"has_attachments"
: false,
16
"id"
: 1234567,
17
"name"
: "John Doe",
18
"priority"
: "High [Private]",
19
"source"
: "Form",
20
"status"
: "Closed",
21
"tags"
: ["general", "customer service", "billing"],
22
"title"
: "test",
23
"updated_time"
: "2020-05-21T14:54:42",
24
"visitor_id"
: "773bb26414957327cd1b97d-1-22255319"
25
}],
26
"total_rows"
: 547
27
},
28
"status": "ok"
29
}