Sites: list
Stay organized with collections
Save and categorize content based on your preferences.
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
).
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-23 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eLists the Search Console sites that a user has access to, along with their permission levels.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization using specific scopes to access the data.\u003c/p\u003e\n"],["\u003cp\u003eUses a simple \u003ccode\u003eGET\u003c/code\u003e request to retrieve the list of sites.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response containing an array of \u003ccode\u003esiteEntry\u003c/code\u003e objects, each representing a Search Console site with its associated permissions.\u003c/p\u003e\n"]]],["This document outlines how to list a user's Search Console sites via the Webmasters API v3. The `GET` request to `https://www.googleapis.com/webmasters/v3/sites` requires authorization using either the `webmasters.readonly` or `webmasters` scope. No request body is needed. A successful response returns a JSON object containing a `siteEntry` list. Each entry details permission level information for a Search Console site. The provided link gives more information on Search Console permissions.\n"],null,["# Sites: list\n\n**Requires [authorization](#auth)**\n\nLists the user's Search Console sites.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/webmasters/v3/sites\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/webmaster-tools/v1/how-tos/authorizing)).\n\n| Scope |\n|-------------------------------------------------------|\n| `https://www.googleapis.com/auth/webmasters.readonly` |\n| `https://www.googleapis.com/auth/webmasters` |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"siteEntry\": [\n sites Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `siteEntry[]` | `list` | Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999). | |\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
