This v1 API  will be deprecated from 15th March 2020

Description:

To fetch all the help topics in Faveo.

URL : api/v1/helpdesk/help-topic

         (Replace this URL with you helpdesk URL)

Parameters :

Name Data Type Required / Optional Description
api_key String Required  An alphanumeric code that can be used to authenticate your API calls
ip String Optional  IP address of the Customer/location where API call is being made from
token String Required  Token generated for a user

 

HTTP Method : GET         

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/help-topic?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9wcm9kdWN0ZGVtb3VybC5jb20vc2FyZnJhei9wdWJsaWMvYXBpL3YxL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTUzNDc1OTg5MiwiZXhwIjoxNTM0NzYwMTMyLCJuYmYiOjE1MzQ3NTk4OTIsImp0aSI6IlhBdzNrNGhwZXNUVWNFeVQifQ.TpuZ6Vwo9oMlt_LKRZYv2cU5UY8YBKqe06-66ioZA24

Response

  •   Response Format : JSON
  •   Returns JSON which contains below response

Sample JSON Success Response :

{

   "result": [

       {

           "id": 1,

           "topic": "Support query",

           "parent_topic": "",

           "custom_form": null,

           "department": 1,

           "ticket_status": 1,

           "thank_page": "",

           "ticket_num_format": "1",

           "internal_notes": "",

           "status": 1,

           "type": 1,

           "auto_response": 0,

           "created_at": "2018-03-08 04:49:30",

           "updated_at": "2018-03-08 04:49:30",

           "nodes": null,

           "linked_departments": null

       },

   ]

}

Response Description: It returns an array which contains a list of help topics with details

Parameter Description
id It is the unique id of the helptopic
topic It is the name of the helptopic
parent_topic It is the parent  name of the helptopic
custom_form It is the last name of the customer
department It is the id of of the department
ticket_status It is id of the ticket status
ticket_num_format It is the id of the format of the ticket
internal_notes It is an id of the internal note
status It is an id of the ticket status
type It is an id of the ticket type
created_at It is the time when this help topic is created
updated_at It is the time when this help topic is updated
linked_departments It is the id of the department which is linked with this help topic

Possible Errors/Failures:

 *Please check the responses for some common errors

Leave a Reply

Your email address will not be published. Required fields are marked *