Sites: list

  • Lists the Search Console sites that a user has access to, along with their permission levels.

  • Requires authorization using specific scopes to access the data.

  • Uses a simple GET request to retrieve the list of sites.

  • Returns a response containing an array of siteEntry objects, each representing a Search Console site with its associated permissions.

Requires authorization

Lists the user's Search Console sites. Try it now.

Request

HTTP request

GET https://www.googleapis.com/webmasters/v3/sites

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/webmasters.readonly
https://www.googleapis.com/auth/webmasters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "siteEntry": [
    sites Resource
  ]
}
Property name Value Description Notes
siteEntry[] list Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.