Get Inbox

Description : To fetch all inbox tickets in FAVEO

23. URL : api/v1/helpdesk/inbox

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 open tickets in FAVEO.In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/inbox?api_key=9p41T2XFZ34YRZJUNQAdmM7iV0Rr1CjN&ip=null&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTQyMzEsImV4cCI6MTUzNTAxNDQ3MSwibmJmIjoxNTM1MDE0MjMxLCJqdGkiOiJRN0NJeVFBQzh5Y1BrSGNjIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.kwH5-HznXnUh4U6atu2ewZYIWCSmYQz1QT-UvPy-YjI

JSON Response Example :

Success Response :

{
    "current_page": 1,
    "data": [
        {
            "updated_at": "2018-08-23 07:32:01",
            "user_name": "user@gmail.com",
            "first_name": "demo",
            "last_name": "user",
            "email": "user@gmail.com",
            "profile_pic": "https://secure.gravatar.com/avatar/cba1f2d695a5ca39ee6f343297a761a4?s=80&r=g&d=identicon",
            "ticket_number": "AAAA-0000-0113",
            "id": 114,
            "title": "test ticket",
            "created_at": "2018-08-23 07:32:01",
            "department_name": "Support",
            "priotity_name": "Low",
            "priority_color": "#00a65a",
            "sla_plan_name": "Sla 1",
            "help_topic_name": "Support query",
            "ticket_status_name": "Open",
            "department_id": 1,
            "user_dpt": null,
            "attachment": 0,
            "overdue_date": "2018-08-23 13:32:01"
        }
    ]
    "first_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/inbox?page=1",
    "from": 1,
    "last_page": 5,
    "last_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/inbox?page=5",
    "next_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/inbox?page=2",
    "path": "http://productdemourl.com/community/public/api/v1/helpdesk/inbox",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 50
}

Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

Response Description :

Parameter	Description
updated_at	indicates last updated time of the ticket
user_name	user name of the user
first_name	first name of the user
last_name	last name of the user
email	email of the user
profile_pic	profile picture of the user
ticket_number	*ticket number *
id	id of the ticket
title	title of the ticket
created_at	ticket creation date
department_name	department name of th ticket
priotity_name	priority name of the ticket
priority_color	priority color of the ticket
sla_plan_name	sla plan of the ticket
help_topic_name	help topic name of the ticket
ticket_status_name	indicates ticket status name
department_id	indicates id of the department
user_dpt	indicates department of the user
attachment	*indicates ticket is having attachment or not *
overdue_date	indicates ticket overdue date
first_page_url	url of the first page
from	indicates the first page
last_page	indicates the last page
last_page_url	url of the last page
next_page_url	url of the next page
path	path of the url
per_page	number of tickets per page
prev_page_url	url of the previous page
to	number of total pages
total	number of tickets