List sites
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.
List all available sites in an organization.
Specific filter criteria and query options are also supported and described below:
Filter statement | Select statement | Description |
---|---|---|
siteCollection/root ne null |
siteCollection,webUrl |
Lists all root-level site collections in the organization. Useful for discovering the home site for each geography. |
In addition, you can use a $search query against the /sites
collection to find sites matching given keywords.
If you want to list all sites across all geographies, refer to getAllSites.
For more guidance about building applications that use site discovery for scanning purposes, see Best practices for discovering files and detecting changes at scale.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
List all site collections
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Not supported. |
Delegated (personal Microsoft account) | Not supported. |
Application | Sites.Read.All, Sites.ReadWrite.All |
Discover the home site for each geography
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 list all available sites in an organization:
GET /sites
To list all root-level site collections in an organization:
GET /sites?$filter=siteCollection/root ne null
Example
Request
GET https://graph.microsoft.com/beta/sites?$select=siteCollection,webUrl&$filter=siteCollection/root%20ne%20null
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740",
"name": "Contoso USA",
"root": { },
"siteCollection": {
"hostname": "contoso.sharepoint.com",
"dataLocationCode": "NAM",
"root": { }
},
"webUrl": "https://contoso.sharepoint.com"
},
{
"id": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
"name": "Contoso Japan",
"root": { },
"siteCollection": {
"hostname": "contoso-jp.sharepoint.com",
"dataLocationCode": "JPN",
"root": { }
},
"webUrl": "https://contoso-jp.sharepoint.com"
}
]
}
Request
GET /sites
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "contoso.sharepoint.com,bf6fb551-d508-4946-a439-b2a6154fc1d9,65a04b8b-1f44-442b-a1fc-9e5852fb946c",
"name": "Root Site",
"root": { },
"siteCollection": {
"hostname": "contoso.sharepoint.com",
"dataLocationCode": "NAM",
"root": { }
},
"webUrl": "https://contoso.sharepoint.com"
},
{
"id": "contoso.sharepoint.com,d9ecf079-9b13-4376-ac5d-f242dda55626,746dbcc1-fa2b-4120-b657-2670bae5bb6f",
"name": "Site A",
"root": { },
"siteCollection": {
"hostname": "contoso.sharepoint.com"
},
"webUrl": "https://contoso.sharepoint.com/sites/siteA"
},
{
"id": "contoso.sharepoint.com,fd1a778f-263e-4c43-acdf-d5c2519d80eb,c06016db-dfec-4f79-83a1-09c6dbfd7022",
"name": "Site B",
"root": { },
"siteCollection": {
"hostname": "contoso.sharepoint.com"
},
"webUrl": "https://contoso.sharepoint.com/sites/siteB"
}
]
}
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