Qodex.ai

List tickets by account

GET {{baseUrl}}/api/v1/accounts/:account_id/tickets

This API lists tickets received from a specific account.

OAuth Scope

  • Desk.tickets.READ
  • Desk.search.READ

Request Params

KeyDatatypeRequiredDescription
departmentIdstringID of the department from which the tickets must be fetched
fromstringIndex number, starting from which the tickets must be fetched
limitstringNumber of tickets to fetch
sortBystringSort by a specific attribute: createdTime or modifiedTime. The default sorting order is ascending. A - prefix denotes descending order of sorting.
dueDatestringFilter by ticket duedate. Values allowed are overdue, tomorrow, currentWeek, currentMonth and today. You can include both values by separating them with a comma
isSpamstringFilters Spam tickets
includestringAdditional information related to the tickets. Values allowed are: contacts, products, departments, team, isRead and assignee. You can pass multiple values by separating them with a comma in the API request.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"ticketNumber":"149","statusType":"Open","subject":"Hi. There is a sudden delay in the processing of the orders. Check this with high priority","dueDate":"2017-11-04T07:03:09.000Z","departmentId":"1892000000006907","channel":"Email","isRead":false,"onholdTime":null,"language":"English","closedTime":null,"contact":{"lastName":"Carol","firstName":"Lucas","phone":"1 888 900 9646","mobile":"8845678909","id":"18944000000421011","type":null,"email":"carol@zylker.com","account":{"website":"www.desk.com","accountName":"desk Account","id":"1892000000975382"}},"createdTime":"2017-10-12T13:11:50.000Z","id":"18944000000336005","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"support@zylker.com","customerResponseTime":"2017-11-03T07:03:09.203Z","productId":"18944000000424033","contactId":"18944000000421011","threadCount":"7","lastThread":null,"team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":"Medium","assigneeId":"1892000000042001","commentCount":"0","phone":"9876543321","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/20d7881a46edfcffefe308ab38676ec3e612657a51fd5fbe","teamId":"8920000000069071","isSpam":false,"assignee":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agent/1892000000042001/photo","id":"1892000000042001","email":"jack@zylker.com"},"status":"Open"}]}