Edit

wellKnownTaskList resource type (deprecated)

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Caution

The to-do API set built on baseTask is deprecated as of May 31, 2022, and will stop returning data on August 31, 2022. Please use the API set built on todoTask.

A built-in task list that can't be renamed or deleted. To Do has two built-in lists, flagged email and tasks list.

This resource supports adding your data to custom properties as open extensions

Inherits from baseTaskList.

Methods

Method Return type Description
List wellKnownTaskLists wellKnownTaskList collection Get a list of the wellKnownTaskList objects and their properties.
Get wellKnownTaskList wellKnownTaskList Read the properties and relationships of a wellKnownTaskList object.
List tasks baseTask collection Get the baseTask resources from the tasks navigation property.
Create baseTask baseTask Create a new baseTask object.

Properties

Property Type Description
displayName String The name of the task list. Inherited from baseTaskList.
id String The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from baseTaskList.
wellKnownListName wellKnownListName_v2 Property indicating the list name if the given list is a well-known list. The possible values are: none, defaultList, flaggedEmails, unknownFutureValue.

wellknownListName values

Member Description
none User created list.
defaultList Built-in tasks list.
flaggedEmails Built-in flagged email list. Tasks from flagged emails are present in this list.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.

Relationships

Relationship Type Description
extensions extension collection The collection of open extensions defined for the task list. Nullable. Inherited from baseTaskList
tasks baseTask collection The tasks in this task list. Read-only. Nullable. Inherited from baseTaskList

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.wellKnownTaskList",
  "displayName": "String",
  "id": "String (identifier)",
  "wellKnownListName": "String"
}