Get Help Topics

Description : To fetch the all help topics in FAVEO.

18. URL : api/v1/helpdesk/help-topic

Parameters :

Name	Data Type	Required/Optional	Description
token	String	Required	token generated for a user
api_key	String	Optional	An alphanumeric code that can be used to authenticate your API calls

HTTP Method : GET

Response Format : JSON

Response : returns all the help topic listed in FAVEO.

http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/help-topic?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTM3ODAsImV4cCI6MTUzNTAxNDAyMCwibmJmIjoxNTM1MDEzNzgwLCJqdGkiOiJVTUhQNm5rb1NSS2FqZDFFIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.r7ao6svVmLnq4AN4bmre28Ikkp5gDsLFgIMxKrU8MIQ

JSON Response Example :

Success Response :

{
    "result": [
        {
            "id": 1,
            "topic": "Support query",
            "parent_topic": "",
            "custom_form": null,
            "department": 1,
            "ticket_status": 1,
            "priority": 2,
            "sla_plan": 1,
            "thank_page": "",
            "ticket_num_format": "1",
            "internal_notes": "",
            "status": 1,
            "type": 1,
            "auto_assign": null,
            "auto_response": 0,
            "created_at": "2018-08-13 14:22:49",
            "updated_at": "2018-08-13 14:22:49"
        }
    ]
}

Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

Parameter	Description
id	id of the help topic
topic	topic indicates department
parent_topic	parent topic associated with this help topic
custom_form	custom form is associated or not
department	department of the help topic
ticket_status	status of the ticket associated with this help topic
priority	priority of the ticket associated with this help topic
sla_plan	sla plan of the ticket associated with this help topic
ticket_num_format	ticket number format associated with this help topic
internal_notes	indicates if the help topic has any internal note or not
status	status of the help topic
type	type of the help topic
auto_assign	indicates if the help topic has auto assign module or not
auto_response	indicates if the help topic has auto response module or not
created_at	help topic created date
updated_at	help topic updated date