Qodex.ai

List tasks

GET {{baseUrl}}/api/v1/tasks

This API fetches a particular number of tasks, based on the limit specified.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the task. Values allowed are: contacts, assignee,tickets,teams,projects.
fromstringIndex number, starting from which the tasks must be fetched
limitstringNumber of tasks to list
departmentIdstringID of the department from which the tasks must be fetched
departmentIdsstringDepartments from which the tasks need to be queried
viewIdstringID of the view to apply while fetching the resources
assigneestringKey that filters tickets by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas.
dueDatestringDue date for completing the task. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth and Today.You can pass multiple values by separating them with commas.
isCompletedstringKey that denotes whether the task is completed or not
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.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"ticket":null,"contactId":null,"subject":"Iphone charger replacement","completedTime":null,"departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000067003","priority":"Normal","isCommented":false,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/d4c0a5dce55dcf20279262cd8594cd0d","contact":null,"createdTime":"2019-04-30T14:21:50.000Z","startTime":"1970-01-01T00:00:00.000Z","id":"5000000209940","assignee":{"firstName":"George","lastName":"36","photoURL":null,"id":"5000000067003"},"isSpam":false,"category":null,"activityType":"Tasks","ticketId":null,"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":null,"subject":"Tempered glass replacement","completedTime":null,"departmentId":"5000000012710","dueDate":"2019-04-25T16:52:11.000Z","creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"High","isCommented":false,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e46474bbeb6432292e","contact":null,"createdTime":"2019-04-09T04:37:26.000Z","startTime":"2019-04-25T16:52:11.000Z","id":"5000000075033","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Tasks","ticketId":"5000000016294","status":"Deferred12546","direction":"inbound"}]}