{"id":9155,"date":"2021-12-14T07:20:36","date_gmt":"2021-12-14T15:20:36","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/?p=9155"},"modified":"2022-10-13T21:08:46","modified_gmt":"2022-10-14T04:08:46","slug":"announcing-the-public-preview-of-to-do-tasks-api","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/announcing-the-public-preview-of-to-do-tasks-api\/","title":{"rendered":"Announcing the public preview of To Do Tasks API"},"content":{"rendered":"

At Microsoft Ignite 2021,\u00a0we\u00a0announced\u00a0the\u00a0private preview\u00a0of\u00a0To Do\u2019s\u00a0new Tasks API<\/a>\u00a0in\u00a0Microsoft\u00a0Graph.\u00a0Today, we\u2019re\u00a0thrilled to announce the public preview of Tasks API on beta endpoint.<\/p>\n

The Tasks API in <\/span>Microsoft <\/span>G<\/span>raph <\/span>helps <\/span>bring user<\/span>s\u2019<\/span> tasks<\/span> from multiple sources such as <\/span>O<\/span>utlook<\/span> emails, Teams cha<\/span>ts<\/span>, <\/span>Office<\/span> documents<\/span> in<\/span>to<\/span> one single place. <\/span>The new endpoint <\/span><\/span>me\/tasks<\/span><\/span> aligns with <\/span>our vision of a single place for all tasks <\/span>of <\/span>a user<\/span>. These APIs allow your apps to <\/span>retrieve<\/span>, create, and organize users\u2019 tasks and task lists.<\/span><\/span>\u00a0<\/span><\/p>\n

The Tasks API provides the following key resources:<\/p>\n

    \n
  1. Task list<\/span><\/b><\/a>: <\/span>Represents a logical container of task items. You can currently create tasks only within a <\/span>Task list<\/span><\/b><\/a>. Task items created without an explicitly specified list container will be created and appear in the default list named \u201c<\/span>Tasks<\/span><\/b>\u201d<\/span>.<\/span>\u00a0<\/span><\/li>\n
  2. Task<\/span><\/b><\/a>: Represents a task, i.e. a piece of work, action or item that can be tracked and completed<\/span>\u00a0<\/span><\/li>\n
  3. Checklist item<\/span><\/b><\/a>:<\/span><\/b> Represents a way to allow splitting a task into smaller steps for easier tracking & completion of the parent task.<\/span>\u00a0<\/span><\/li>\n
  4. Linked resource<\/span><\/span><\/a><\/strong>:<\/strong> Represents a<\/span>n<\/span> item from a <\/span>partner application <\/span>related to the task. You can use it to store information and the link back to the related item in your app.<\/span><\/span>\u00a0<\/span><\/li>\n<\/ol>\n

    Added capabilities of new Tasks API<\/h3>\n

    Along with the capabilities that are present in the existing To Do APIs, we are bringing the new capabilities to Tasks API.<\/p>\n

      \n
    1. Retrieve all task for a user using AllTasks<\/code> endpoint<\/li>\n<\/ol>\n

      AllTasks<\/code> endpoint allows applications to get all <\/span>tasks of a user<\/span> in one single call. Further, applications <\/span>can <\/span>apply<\/span> OData<\/span> filter<\/span>s<\/span> on the <\/span>task properties <\/span>to get only the <\/span>relevant<\/span> tasks.<\/span> Application can also quickly create <\/span>tasks in<\/span> the defaul<\/span>t <\/span>\u201c<\/span><\/span>T<\/span>asks<\/span><\/span><\/strong>\u201d<\/span><\/span> list <\/span>from this endpoint<\/span>.<\/span>\u00a0<\/span><\/span>\u00a0<\/span><\/p>\n

        \n
      1. Create steps using checklist item API<\/li>\n<\/ol>\n

        Application can now split a task into smaller steps that can be completed separately. This is helpful for better planning and tracking of complex tasks.<\/p>\n

          \n
        1. Move tasks across lists<\/li>\n<\/ol>\n

          Using the new move operation on tasks, application can now move tasks across lists. Also, with support of immutable tasks ids, ids do not change during move operation within the mailbox.<\/p>\n

          Illustrative use of Tasks API<\/h3>\n

          Here are some examples of how you can use the Tasks APIs in beta endpoint<\/p>\n

            \n
          1. If you want to see all your tasks in the mailbox without any filter, call the API as shown below<\/li>\n<\/ol>\n
            GET https:\/\/graph.microsoft.com\/beta\/me\/tasks\/AllTasks<\/a><\/pre>\n
              \n
            1. You can also use any filter on this endpoint. For example, if you want to see all important tasks, call the following API<\/li>\n<\/ol>\n
              GET https:\/\/graph.microsoft.com\/beta\/me\/tasks\/AllTasks$filter=<\/a>importance eq high<\/pre>\n
                \n
              1. To get tasks in a particular list, you can call the following endpoint<\/li>\n<\/ol>\n
                GET https:\/\/graph.microsoft.com\/beta\/me\/tasks\/lists\/{list-id}\/tasks<\/a><\/pre>\n
                For more details, check out the documentation<\/a>.<\/p>\n
                What’s Next?<\/h3>\n
                Our roadmap beyond the GA release of this API includes adding support for categories, attachments, and application permission.<\/p>\n
                We can\u2019t wait for you to try out this API as we continue to work towards improving user productivity. For any feedback, suggestions or questions on the API, you can reach out through this form<\/a>\u00a0or email us at todofeedback@microsoft.com<\/a>.<\/p>\n
                Happy coding!<\/p>\n
                 <\/p>\n
                 <\/p>\n","protected":false},"excerpt":{"rendered":"
                At Microsoft Ignite 2021, we announced our private preview for the new Tasks API in Microsoft Graph. Today, we\u2019re thrilled to announce the public preview of Tasks API on beta endpoint.<\/p>\n","protected":false},"author":69077,"featured_media":9157,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3],"tags":[156,209],"class_list":["post-9155","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph","tag-to-do-api","tag-to-do-tasks"],"acf":[],"blog_post_summary":"
                At Microsoft Ignite 2021, we announced our private preview for the new Tasks API in Microsoft Graph. Today, we\u2019re thrilled to announce the public preview of Tasks API on beta endpoint.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/9155","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69077"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=9155"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/9155\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/9157"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=9155"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=9155"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=9155"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}

    \"Image<\/a><\/p>\n