specialFolder resource type

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.

Groups special folder-related data items into a single structure.

If a driveItem has a non-null specialFolder facet, the item represents a special (named) folder. Special folders can be accessed directly via the special folders collection.

Special folders provide simple aliases to access well-known folders without the need to look up the folder by path (which would require localization), or reference the folder with an ID. If a special folder is renamed or moved to another location within the drive, this syntax will continue to return that folder.

Special folders are automatically created the first time an application attempts to write to one, if it doesn't already exist. If a user deletes one, it is recreated when written to again.

The following special folder names are available in OneDrive and OneDrive for Business.

Name	Folder ID	Description
Documents	documents	The Documents folder.
Photos	photos	The Photos folder.
Camera Roll	cameraroll	The Camera Roll Backup folder.
App Root	approot	The application's personal folder. Usually in /Apps/{Application Name}.
Music	music	The Music folder.
Recordings	recordings	The Recordings folder. This option is only available in OneDrive for Business and SharePoint Online.

Note: If your app has only requested Files.Read scope and requests a special folder that doesn't exist, the response will be a 403 Forbidden error.

Properties

Property	Type	Description
name	string	The unique identifier for this item in the /drive/special collection

JSON representation

{
  "name": "string"
}

Related content

For more information about the facets on a driveItem, see driveItem.