Sitemaps: list
Stay organized with collections
Save and categorize content based on your preferences.
Requires authorization
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
Try it now.
Request
HTTP request
GET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps
Parameters
| Parameter name |
Value | url
Description |
| Path parameters |
siteUrl |
string |
The URL of the property as defined in Search Console. For example:
http://www.example.com/
(URL-prefix property),
or sc-domain:example.com
(Domain property).
|
| Optional query parameters |
sitemapIndex |
string |
A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml
|
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:
{
"sitemap": [
sitemaps Resource
]
}
| Property name |
Value |
Description |
Notes |
sitemap[] |
list |
Contains detailed information about a specific URL submitted as a sitemap. |
|
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.
[null,null,["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eLists sitemaps submitted for a site, including those in the sitemap index file.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eEmploys a simple GET request with optional parameters for filtering.\u003c/p\u003e\n"],["\u003cp\u003eResponse provides detailed information about each submitted sitemap.\u003c/p\u003e\n"],["\u003cp\u003eAllows users to try the API call directly using the provided explorer tool.\u003c/p\u003e\n"]]],["This API endpoint retrieves a list of sitemap entries for a specified site. The request, using `GET`, requires the `siteUrl` path parameter, which is the site's URL as defined in Search Console. Optionally, it takes a `sitemapIndex` query parameter to list entries within a specific sitemap index. Authorization is necessary using `webmasters.readonly` or `webmasters` scopes. A successful response returns a list of sitemap resources, each detailing a submitted URL. No request body is needed.\n"],null,["# Sitemaps: list\n\n**Requires [authorization](#auth)**\n\nLists the [sitemaps-entries](/webmaster-tools/v1/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `siteUrl` | `string` | The URL of the property as defined in Search Console. For example: `http://www.example.com/` ([URL-prefix](https://support.google.com/webmasters/answer/34592#url_prefix_prop_tips) property), or `sc-domain:example.com` ([Domain](https://support.google.com/webmasters/answer/34592#domain_property) property). |\n| **Optional query parameters** |||\n| `sitemapIndex` | `string` | A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml` |\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 \"sitemap\": [\n sitemaps Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|--------|-----------------------------------------------------------------------------------------------------------------------------------|-------|\n| `sitemap[]` | `list` | Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184). | |\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
