List lists (deprecated)

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 was deprecated on May 31, 2022, and stopped returning data on August 31, 2022. Use the todoTask API instead.

Get a list of the baseTaskList objects of a user and their properties.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Tasks.Read	Tasks.ReadWrite
Delegated (personal Microsoft account)	Tasks.Read	Tasks.ReadWrite
Application	Not supported.	Not supported.

HTTP request

GET /me/tasks/lists
GET /users/{userId|userPrincipalName}/tasks/lists

Optional query parameters

This method supports $expand, $filter and $top OData query parameters to customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of baseTaskList objects in the response body.

Examples

Request

HTTP

GET https://graph.microsoft.com/beta/me/tasks/lists

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let lists = await client.api('/me/tasks/lists')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "value": [
        {
            "@odata.type": "#microsoft.graph.wellKnownTaskList",
            "@odata.etag": "W/\"kOO4xOT//0qFRAqk3TNe0QAAAAAAkw==\"",
            "wellKnownListName": "defaultList",
            "displayName": "Tasks",
            "id": "AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMj"
        }
    ]
}