Retrieve all sites and all subsites from the SharePoint REST API

Question

Using the SharePoint Online REST API, I'm trying to retrieve a list of all sites and subsites.

This API gives me all top level sites, but no subsites:

https://{mycompany}.sharepoint.com/_api/search/query
   ?querytext='contentclass:STS_Site'

Either of these APIs gives me all sub-sites of the root top level site:

https://{mycompany}.sharepoint.com/_api/search/query
   ?querytext='contentclass:STS_Web'

https://{mycompany}.sharepoint.com/_api/search/query?
   querytext='*'
   &refinementfilters='contentclass:equals("STS_Web")'

I'd like a single query which retrieves all sites and all of their subsites -- not just subsites of the root site.

Edit:

Now I've had time to come back to this, as suggested by @Gautam Sheth I've tried this:

https://{mycompany}.sharepoint.com/_api/search/query
   ?querytext='contentclass:STS_Site contentclass:STS_Web'
   &selectproperties='Title,Path'&rowlimit=500

It's not quite working though. In a site structured like so, only the checked (✅) sites and subsites are being returned in the response:

• ✅ Example Inc - Team Site (the default root site)
  • ✅ Subsite of Example Inc - Team Site
    • Nested subsite of Subsite of Example Inc - Team Site
    • Nested subsite #2 of Subsite of Example Inc - Team Site
  • Subsite #2 of Example Inc - Team Site
  • Subsite #3 of Example Inc - Team Site
• ✅ David's Test Site (another top level site)
  • Subsite of David's Test Site

Answer 1

You need to use STS_Site and STS_Web both in your queryText.

Your REST API endpoint should be as below:

https://{mycompany}.sharepoint.com/_api/search/query?
querytext='contentclass:STS_Site contentclass:STS_Web'
&selectproperties='Title,Path'&rowlimit=500

Am able to get deep subsites as well using the above endpoint . Check the below screenshot which shows the deep subsite.

Answer 2

✅ If you just want to get a list of site & subsite URLs, you can cheat slightly.

Instead of looking for the sites or subsites, look for a /path/to/newsfeed.aspx entry instead. This appears to be present for all sites and subsites.

Here's the URL:

https://{mycompany}.sharepoint.com/_api/search/query
   ?querytext='*/newsfeed.aspx'&trim&selectproperties='ParentLink'

The ParentLink property contains the base URL for the site/sub-site.

While this is correct, it just feels like the wrong way of doing things.

This method also does not return the actual name of the site/sub-site, so is only a partial answer, but the best I can find right now.

---

If you can use the Microsoft Graph, it's much easier...

https://graph.microsoft.com/v1.0/sites?search=*

...will give all sites and subsites with their names 🙌

Answer 3

You can use below code to achieve above functionality : Below code fetches Subsites of root site and their subsite mentioning their parents as well. Hope this solves your issue

//common Ajax call function which sends back the response call
function GETMethodAjaxCall(url, success) {
$.ajax({
    type: "GET",
    contentType: "application/json",
    url: url,
    headers: {
        "Accept": "application/json; odata=verbose"
    },
    dataType: "json",
    success: function(response) {
        success(response);
    },
    error: function(err) {
        alert("error")
    }
});
}
$(document).ready(function() {

var url = _spPageContextInfo.webAbsoluteUrl + "/_api/Web/webs";

GETMethodAjaxCall(url, function(data) {
    $.each(data.d.results, function(index, value) {
        console.log("Site: " + value.Title + " " + "is Parent Site");

        GETMethodAjaxCall(value.Url + "/_api/Web/webs", function(data) {
            $.each(data.d.results, function(ind, val) {
                console.log("SubSite: " + val.Title + " " + "is child of " + value.Title);
            });
        });

    });    
});
});