Skip to content

Get Tickets

Sayar Samanta edited this page Aug 28, 2018 · 2 revisions

Description : To fetch all tickets in FAVEO

  1. URL : api/v1/helpdesk/tickets

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 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/tickets?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTQwNDgsImV4cCI6MTUzNTAxNDI4OCwibmJmIjoxNTM1MDE0MDQ4LCJqdGkiOiJwM0h4TjJUMUVSbXRFbTJuIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.CDAGq6xATQLCMALLWHH6JihcBpNhLLeaezp-o_AlCUE

JSON Response Example :

Success Response :

{
    "current_page": 1,
    "data":[
       {
            "id": 108,
            "ticket_number": "AAAA-0000-0107",
            "user_id": 16,
            "dept_id": 1,
            "team_id": null,
            "priority_id": 1,
            "sla": 1,
            "help_topic_id": 1,
            "status": 1,
            "rating": 0,
            "ratingreply": 0,
            "flags": 0,
            "ip_address": 0,
            "assigned_to": null,
            "lock_by": 0,
            "lock_at": null,
            "source": 2,
            "isoverdue": 0,
            "reopened": 0,
            "isanswered": 0,
            "html": 0,
            "is_deleted": 0,
            "closed": 0,
            "is_transferred": 0,
            "transferred_at": "0000-00-00 00:00:00",
            "reopened_at": null,
            "duedate": "2018-08-23 06:00:36",
            "closed_at": null,
            "last_message_at": null,
            "last_response_at": null,
            "approval": 0,
            "follow_up": 0,
            "created_at": "2018-08-23 00:00:36",
            "updated_at": "2018-08-23 00:00:36"
        }
    ],
    "first_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/tickets?page=1",
    "from": 1,
    "last_page": 12,
    "last_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/tickets?page=12",
    "next_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/tickets?page=2",
    "path": "http://productdemourl.com/community/public/api/v1/helpdesk/tickets",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 115
}

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
id id of the user
ticket_number ticket number of the user
user_id id of the user
dept_id id of the department
team_id id of the team
priority_id id of the priority
sla id of the sla
help_topic_id id of the help topic
status id of the staus
rating indicates rating for the ticket
ratingreply indicates rating for the reply
flags indicates flags for the ticket
ip_address indicates the ip address from which the ticket is created
assigned_to indicates the agent to whom the ticket is assigned
source indicates the source of the ticket
isoverdue indicates the ticket is in overdue mode or not
reopened indicates if the ticket is reopened or not
isanswered indicates if the ticket is answered or not
is_deleted indicates if the ticket is deleted or not
closed indicates if the ticket is closed or not
transferred_at indicates ticket transfer time
reopened_at indicates ticket reopen time
duedate indicates ticket due date timer
closed_at indicates ticket closed time
last_message_at indicates the last message time for the ticket
last_response_at *indicates the last response time of the ticket *
follow_up first name of the user
created_at indicates ticket creation time
updated_at indicates ticket updated time
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

Installation and Upgrade Guide

Administrator's Guide

Agent's Guide

Email Integration

Release & Upgrade Notes

Known Issues

Contribute & Feedback

Knowledge Base

Third Party Integration

Plugins

API

Clone this wiki locally