Get a site 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.
Retrieve properties and relationships for a site resource. A site resource represents a team site in SharePoint.
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 the tenant's root site
To access the root SharePoint site within a tenant:
GET /sites/root
GET /sites/contoso.sharepoint.com
Access a site by server-relative URL
If you have the server-relative URL for a site resource, you can construct a request as follows:
GET /sites/{hostname}:/{server-relative-path}
Access a group team site
To access the team site for a group:
GET /groups/{group-id}/sites/root
Examples
Example 1: Get a site using the site ID
Request
GET /sites/{site-id}
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE",
"owner": {
"user": {
"displayName": "Daron Spektor",
"id": "5280E7FE-DC7A-4486-9490-E790D81DFEB3"
}
},
"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"
}
Example 2: Get a site by server relative URL
Request
GET https://graph.microsoft.com/v1.0/sites/{hostname}:/{server-relative-path}
Response
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"
}
Example 3: Get the site of a group
Request
GET https://graph.microsoft.com/v1.0/groups/{group-id}/sites/root
Response
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"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for