Sitemaps: list

  • Lists sitemaps submitted for a site, including those in the sitemap index file.

  • Requires authorization with specific scopes for access.

  • Employs a simple GET request with optional parameters for filtering.

  • Response provides detailed information about each submitted sitemap.

  • Allows users to try the API call directly using the provided explorer tool.

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

url
Parameter name ValueDescription
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.