List events by ticket

GET {{baseUrl}}/api/v1/tickets/:ticket_id/events

This API lists a particular number of events associated with a ticket, based on the limit specified.

OAuth Scope

  • Desk.activities.events.READ
  • Desk.activities.READ
  • Desk.tickets.READ
  • Desk.events.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the events must be listed
isCompletedstringKey that denotes if the event was completed or not
isSpamstringKey that denotes whether to fetch spam events or not
limitstringNumber of events to list
sortBystringSort by a specific attribute: startTime or createdTime.The default sorting order is ascending. A - prefix denotes descending order of sorting.
includestringAllowed values are : contacts, assignee,tickets,teams.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"subject":"Zoholics at Australia","completedTime":null,"departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e4McKinsonf5d2f01bbb8bd4","isCommented":true,"contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","secId":"9d4883f2d94d59e42b7cc45393ad8ff8"},"createdTime":"2019-04-04T06:48:36.000Z","startTime":"2019-04-18T06:30:00.000Z","id":"5000000065115","direction":"inbound","ticket":{"ticketNumber":"101","phone":"1 888 900 9646","subject":"Here's your first ticket.","dueDate":"2019-03-29T09:51:26.000Z","teamId":null,"id":"5000000016294","assignee":{"photoURL":null,"firstName":"George","lastName":"McKinson","id":"5000000015911"},"status":"Open","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":"5000000016252","team":null,"priority":"High","layoutId":"5000000013470","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/9d4883f2d94d59e4McKinsonf5d2f01bbb8bd4","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Meeting","activityType":"Events","ticketId":"5000000016294","status":"Not Started"},{"subject":"sadfsadf","completedTime":null,"departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e41c8e46db1a43ba49","isCommented":true,"contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","secId":"9d4883f2d94d59e42b7cc45393ad8ff8"},"createdTime":"2019-04-16T12:02:27.000Z","startTime":"2019-04-25T06:30:00.000Z","id":"5000000084070","direction":"inbound","ticket":{"ticketNumber":"101","phone":"1 888 900 9646","subject":"Here's your first ticket.","dueDate":"2019-03-29T09:51:26.000Z","teamId":null,"id":"5000000016294","assignee":{"photoURL":null,"firstName":"George","lastName":"McKinson","id":"5000000015911"},"status":"Open","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":"5000000016252","team":null,"priority":"High","layoutId":"5000000013470","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/9d4883f2d94d59e41c8e46db1a43ba49","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Meeting","activityType":"Events","ticketId":"5000000016294","status":"Not Started"}]}