Edit

Share via

Get a site resource by path

  • Article

Retrieve properties and relationships for a site resource. A site resource represents a team site in SharePoint.

In addition to retrieving a site by ID you can retrieve a site based on server-relative URL path.

  • Site collection hostname (contoso.sharepoint.com)
  • Site path, relative to server hostname.

There is also a reserved site identifier, root, which always references the root site for a given target, as follows:

  • /sites/root: The tenant root site.
  • /groups/{group-id}/sites/root: The group's team site.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Sites.Read.All, Sites.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Sites.Read.All, Sites.ReadWrite.All

HTTP Request

To access the root SharePoint site with a relative path:

GET /sites/{hostname}:/{relative-path}

HTTP Response

This method returns a site resource for the site referenced by the unique identifier.

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

{
  "id": "contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE",
  "displayName": "OneDrive Team Site",
  "name": "1drvteam",
  "createdDateTime": "2017-05-09T20:56:00Z",
  "lastModifiedDateTime": "2017-05-09T20:56:01Z",
  "webUrl": "https://contoso.sharepoint.com/teams/1drvteam"
}