List resource

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.

The list resource represents a list in a site. This resource contains the top level properties of the list, including template and field definitions.

Tasks on a list

The following tasks are available for list resources.

All examples below are relative to a site, for example, https://graph.microsoft.com/beta/sites/{site-id}.

Common task	HTTP method
Get lists in a site	GET /sites/{site-id}/lists
Create list	POST /lists
Get list	GET /lists/{list-id}
Enumerate list items	GET /lists/{list-id}/items
Update list item	PATCH /lists/{list-id}/items/{item-id}
Delete list item	DELETE /lists/{list-id}/items/{item-id}
Create list item	POST /lists/{list-id}
Get recent activities	GET /lists/{list-id}/activities
Get WebSocket channel	GET /lists/{list-id}/subscriptions/socketIo
List content types	GET /lists/{list-id}/contentTypes
Add copy of content type from site	POST /lists/{list-id}/contentTypes/addCopy
List columns	GET /lists/{list-id}/columns
Create column	POST /lists/{list-id}/columns
List operations	GET /lists/{list-id}/operations

Properties

The list resource has the following properties.

Property	Type	Description
columns	Collection(columnDefinition)	The collection of field definitions for this list.
contentTypes	Collection(contentType)	The collection of content types present in this list.
displayName	string	The displayable title of the list.
list	listInfo	Provides additional details about the list.
system	systemFacet	If present, indicates that this is a system-managed list. Read-only.

The following properties are inherited from baseItem.

Property name	Type	Description
id	string	The unique identifier of the item. Read-only.
name	string	The name of the item.
createdBy	identitySet	Identity of the creator of this item. Read-only.
createdDateTime	DateTimeOffset	The date and time the item was created. Read-only.
description	string	The descriptive text for the item.
lastModifiedBy	identitySet	Identity of the last modifier of this item. Read-only.
lastModifiedDateTime	DateTimeOffset	The date and time the item was last modified. Read-only.
webUrl	string (url)	URL that displays the item in the browser. Read-only.

Relationships

The list resource has the following relationships to other resources.

Relationship	Type	Description
activities	itemActivity collection	The recent activities that took place within this list.
drive	drive	Only present on document libraries. Allows access to the list as a drive resource with driveItems.
items	Collection(listItem)	All items contained in the list.
subscriptions	subscription collection	The set of subscriptions on the list.
operations	richLongRunningOperation collection	The collection of long running operations for the list.

JSON representation

The following is a JSON representation of the resource.

{
  "activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
  "columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
  "contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
  "displayName": "title of list",
  "drive": { "@odata.type": "microsoft.graph.drive" },
  "items": [ { "@odata.type": "microsoft.graph.listItem" } ],
  "list": {
    "@odata.type": "microsoft.graph.listInfo",
    "hidden": false,
    "template": "documentLibrary | genericList | survey | links | announcements | contacts ..."
  },
  "system": false,
  "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],

  /* inherited from baseItem */
  "id": "string",
  "name": "name of list",
  "createdBy": { "@odata.type": "microsoft.graph.identitySet" },
  "createdDateTime": "timestamp",
  "description": "description of list",
  "eTag": "string",
  "lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" },
  "lastModifiedDateTime": "timestamp",
  "webUrl": "url to visit the list in a browser"
}