Get a site resource by path

Article
01/27/2024

Namespace: microsoft.graph

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

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)	Sites.Read.All	Sites.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Sites.Read.All	Sites.ReadWrite.All

HTTP Request

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

Request headers

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

Example

Request

To access the root SharePoint site with a relative path:

GET https://graph.microsoft.com/v1.0/sites/{hostname}:/{relative-path}

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",
  "isPersonalSite": false,
  "name": "1drvteam",
  "createdDateTime": "2017-05-09T20:56:00Z",
  "lastModifiedDateTime": "2017-05-09T20:56:01Z",
  "webUrl": "https://contoso.sharepoint.com/teams/1drvteam"
}

Share via