list.md

List children for an item

Items with the folder facet or package facet may contain one or more child items. This API lists the contents of the item's children collection using either the item ID or path to the item.

Prerequisites

To call this API, the user must have granted the application read access to the drive.

HTTP request

GET /drive/items/{item-id}/children
GET /drive/root:/{item-path}:/children

Optional query parameters

This method supports the OData Query Parameters to filter and shape the response.

Optional request headers

Header name	Value	Description
if-none-match	etag	If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned.

Request body

Do not supply a request body with this method.

Example

GET /drive/root/children

Response

If successful, this method returns the list of items in the children collection of the target item. The children collection will be composed of Item resources.

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

{
  "value": [
    {"name": "myfile.jpg", "size": 2048, "file": {} },
    {"name": "Documents", "folder": { "childCount": 4} },
    {"name": "Photos", "folder": { "childCount": 203} },
    {"name": "my sheet(1).xlsx", "size": 197 }
  ],
  "@odata.nextLink": "https://..."
}

Note: Response objects are truncated for clarity. All default properties will be returned from the actual call.

Note: If a collection exceeds the default page size (200 items), the @odata.nextLink property is returned in the response to indicate more items are available and provide the request URL for the next page of items. You can control the page size through optional query string parameters.

Error responses

See Error Responses for more info about how errors are returned.