Callback Search Endpoint

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

GET //developer.livehelpnow.net/api/callback/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 count/limit per page for result set

Result

{
 "status": "ok",
 "payload": {
  "callbacks": [
   {
    "id": 12345,
    "status": "Open",
    "created_time": "2017-01-01T10:00:00.000000Z",
    "created_by": "12345",
    "assigned_operator": 12345,
    "assigned_operator_name": "Operator Name",
    "country_code": "US",
    "fields": [
     {
      "id": 12345,
      "crm_id": 48,
      "label": "Field Label",
      "value": "Field Value",
     },
    ...
    ],
    "title": "Callback Title",
    "subtitle": "Callback Subtitle",
   },
   ...
  ],
  "total_rows": 10,
  "count": 10,
  "start_index": 1
 }
}

callbacks array The list of callbacks
 id integer A unique identifier for the callback
 status string The status for the callback
Will be Open, Escalated, Assigned or Closed
 created_time string The date and time for the callback
 created_by string The unique identifier for the creator of the callback (visitor or operator)
 assigned_operator integer The unique identifier for the operator if assigned
 assigned_operator_name string The name of the operator if assigned
 country_code string The visitor's current ISO2 country code
 fields array The list of fields for the callback
  id integer A unique identifier for the callback field
  crm_id integer The LiveHelpNow CRM id for the callback field
  label label The label of the callback field
  value value The submitted value of the callback field
 title string The title of the callback
 subtitle string The subtitle of the callback
total_rows integer The total number of callbacks matched
count integer The number of visitors callbacks within the payload
start_index integer The start index for the current callbacks within the payload