Qodex.ai

List events

GET {{baseUrl}}/v1/events

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

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the event. Values allowed are: contacts, assignee,tickets,teams.
fromstringIndex number, starting from which the events must be fetched
limitstringNumber of events to list
startTimestringStart time for completing the event. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth and Today.You can pass multiple values by separating them with commas.
departmentIdstringID of the department from which the events must be fetched
departmentIdsstringDepartments from which the events need to be queried
assigneestringKey that filters tickets by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas.
viewIdstringID of the view to apply while fetching the resources
isCompletedstringKey that denotes whether the event is completed or not
sortBystringKey that sorts the events by a specific attribute: startTime or createdTime.The default sorting order is ascending. A - prefix denotes descending order of sorting.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"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"},"isSpam":false,"status":"Open"},"contactId":"5000000016252","subject":"Partner's conference'","completedTime":null,"departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"High","isCommented":true,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/9d4883f2d94d59e4McKinsonf5d2f01bbb8bd4","contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","isSpam":false},"createdTime":"2019-04-04T06:48:36.000Z","startTime":"2019-04-18T06:30:00.000Z","id":"5000000065115","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Meeting","activityType":"Events","ticketId":"5000000016294","status":"Not Started","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"},"isSpam":false,"status":"Open"},"contactId":"5000000016252","subject":"Developers meet","completedTime":null,"departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"High","isCommented":true,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/9d4883f2d94d59e41c8e46db1a43ba49","contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","isSpam":false},"createdTime":"2019-04-16T12:02:27.000Z","startTime":"2019-04-25T06:30:00.000Z","id":"5000000084070","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Meeting","activityType":"Events","ticketId":"5000000016294","status":"Not Started","direction":"inbound"}]}