Ticket List
NOTE: User must me logged in to use this API
URL : v3/api/client/ticket-list
Method : GET
Note : By default, you will be able to view your tickets only. Organization manager can view their organization tickets, by passing organization-ids parameter.
Query Parameters :
Parameter | Type | Possible Values | Required/Optional | Description |
organization-ids | Array | Array of organization ids | Optional | User can see his/her organization tickets, if he is a manager of that organization. |
search-query | String | any | Optional | Search string given in the datatable.
By default its value is empty |
limit | Integer | any | Optional | Number of tickets that are reuired to display on a partiular page.
By default its value is 10 |
page | integer | any | Optional | This is the current page in the ticket list.
By default its value is 1 |
sort-field | String | ticket_number, updated_at (for last_activity) | Optional | The field that is required to be sorted.
By default its value is updated_at (last_activity) |
sort-order | String | asc, desc | Optional | The order in which field is required to be sorted
By default its value is desc |
status-ids | Array | Array of integers | Optional | The status ids by which ticket is required to be filtered |
Response:
{ "success": true, "data": { "current_page": 1, "data": [ { "id": 6, "updated_at": "2020-11-24 12:00:30", "ticket_number": "AAAA-AAAA-0006", "thread_count": 1, "collaborator_count": null, "attachment_count": 0, "poster": "client", "encrypted_id": "eyJpdiI6ImFPNjZ4VG5ORDdiUXNCRFUzTzd4R0E9PSIsInZhbHVlIjoiOWhjZXkxcm02UkMzRWtHXC9OejZtUEE9PSIsIm1hYyI6ImM3MjMyZWY0NWNkMzhhMjEwNGRmZWE5YTkyNzVlMzdmZmNhN2I5NjMwN2VlYjE0ZjkxZTNjZDkxMDhiYTA4ZGUifQ==", "user": { "id": 4, "user_name": "userb", "first_name": "Userb", "last_name": "Userb", "profile_pic": "https://secure.gravatar.com/avatar/bde0257ed5671fa2921c31d6696c6d47?s=80&r=g&d=mm", "email": "userb@faveo.com", "full_name": "Userb Userb", "meta_name": "Userb Userb <userb@faveo.com>", "email_verified": false, "mobile_verified": false }, "first_thread": { "id": 6, "ticket_id": 6, "title": "Ticket 6" }, "last_thread": { "id": 6, "ticket_id": 6, "user_id": 4, "thread_type": null, "poster": "client", "source": null, "reply_rating": 0, "rating_count": 0, "is_internal": 0, "title": "Ticket 6", "body": "asdf", "format": "", "ip_address": "", "created_at": "2020-11-24 12:00:30", "updated_at": "2020-11-24 12:00:30", "response_time": null, "user": { "id": 4, "user_name": "userb", "first_name": "Userb", "last_name": "Userb", "profile_pic": "https://secure.gravatar.com/avatar/bde0257ed5671fa2921c31d6696c6d47?s=80&r=g&d=mm", "email": "userb@faveo.com", "full_name": "Userb Userb", "meta_name": "Userb Userb <userb@faveo.com>", "email_verified": false, "mobile_verified": false }, "attach": [] }, "collaborator": [], "collaborator_count_relation": [] }, { "id": 5, "updated_at": "2020-11-24 12:00:14", "ticket_number": "AAAA-AAAA-0005", "thread_count": 1, "collaborator_count": null, "attachment_count": 0, "poster": "client", "encrypted_id": "eyJpdiI6IjErajByU2pkeUNKMVdwY1NPQ2N1anc9PSIsInZhbHVlIjoiZHF5TjR0K0VDQzlFcjZNYlwvQXRYRVE9PSIsIm1hYyI6IjRjY2QxOTY4NWQzZTM1ZGJiMTk0MjE3MzRhNGVkYTBlOTE0YjFhYTlmMWM3MjQ1YzlmNmVhY2JhYTI3ZWI3ZWEifQ==", "user": { "id": 4, "user_name": "userb", "first_name": "Userb", "last_name": "Userb", "profile_pic": "https://secure.gravatar.com/avatar/bde0257ed5671fa2921c31d6696c6d47?s=80&r=g&d=mm", "email": "userb@faveo.com", "full_name": "Userb Userb", "meta_name": "Userb Userb <userb@faveo.com>", "email_verified": false, "mobile_verified": false }, "first_thread": { "id": 5, "ticket_id": 5, "title": "Ticket 5" }, "last_thread": { "id": 5, "ticket_id": 5, "user_id": 4, "thread_type": null, "poster": "client", "source": null, "reply_rating": 0, "rating_count": 0, "is_internal": 0, "title": "Ticket 5", "body": "sadf", "format": "", "ip_address": "", "created_at": "2020-11-24 12:00:14", "updated_at": "2020-11-24 12:00:14", "response_time": null, "user": { "id": 4, "user_name": "userb", "first_name": "Userb", "last_name": "Userb", "profile_pic": "https://secure.gravatar.com/avatar/bde0257ed5671fa2921c31d6696c6d47?s=80&r=g&d=mm", "email": "userb@faveo.com", "full_name": "Userb Userb", "meta_name": "Userb Userb <userb@faveo.com>", "email_verified": false, "mobile_verified": false }, "attach": [] }, "collaborator": [], "collaborator_count_relation": [] } ], "first_page_url": "http://localhost/faveo-helpdesk-advance/public/v3/api/client/ticket-list?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost/faveo-helpdesk-advance/public/v3/api/client/ticket-list?page=1", "next_page_url": null, "path": "http://localhost/faveo-helpdesk-advance/public/v3/api/client/ticket-list", "per_page": 10, "prev_page_url": null, "to": 2, "total": 2 } }