Qodex.ai

List tasks by ticket

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

This API lists all tasks associated with a particular ticket.

OAuth Scope

  • Desk.activities.READ
  • Desk.activities.tasks.READ
  • Desk.tickets.READ
  • Desk.tasks.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the tasks must be fetched
isCompletedstringKey that denotes whether the task is completed or not
isSpamstringKey that denotes whether to fetch spam tasks or not
limitstringNumber of tasks to list
sortBystringKey that sorts the tasks by a specific attribute: dueDate or createdTime.The default sorting order is ascending. A - prefix denotes a descending order of sorting.
includestringAdditional information related to the task. Values allowed are: contacts, assignee,tickets,teams,projects.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"subject":"New gadget replacement with latest OS","completedTime":null,"departmentId":"5000000012710","dueDate":"2019-04-25T16:52:11.000Z","creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e4d4dad33a9adf3649","isCommented":false,"contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","isSpam":false,"secId":"9d4883f2d94d59e42b7cc45393ad8ff8"},"createdTime":"2019-04-08T07:26:26.000Z","startTime":"2019-04-25T16:52:11.000Z","id":"5000000074002","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","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":"5000000016252","team":null,"priority":"High","layoutId":"5000000013466","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e4d4dad33a9adf3649","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Tasks","ticketId":"5000000016294","status":"Deferred"},{"subject":"Tempered glass replacement","completedTime":null,"departmentId":"5000000012710","dueDate":"2019-04-25T16:52:11.000Z","creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e46474bbeb6432292e","isCommented":false,"contact":null,"createdTime":"2019-04-09T04:37:26.000Z","startTime":"2019-04-25T16:52:11.000Z","id":"5000000075033","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","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":null,"team":null,"priority":"High","layoutId":"5000000013466","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e46474bbeb6432292e","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Tasks","ticketId":"5000000016294","status":"Deferred12546"}]}