---
metadata:
  - name: generator
    content: Diplodoc Platform v5.44.0
alternate:
  - https://yandex.com/dev/webmaster/doc/en/reference/host-sitemaps-get.md
  - https://yandex.com/dev/webmaster/doc/ru/reference/host-sitemaps-get.md
keywords:
  - l
  - i
  - s
  - t
  - ' '
  - o
  - f
  - S
  - e
  - m
  - a
  - p
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/webmaster/doc/en/llms.txt


# Getting the list of Sitemap files

Returns a list of Sitemap files detected by Yandex robots.

## Request format

```
GET https://api.webmaster.yandex.net/v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/sitemaps
  ? [[parent_id](*parent_id)=<sitemap id (string)>]
  & [[limit](*limit)=<int32>]
  & [[from](*from)=<sitemap id (string)>]
```


#|
||
`user-id`
|
<!-- source: en/_includes/popups.md -->
Type: `int64`. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the [GET /v4/user](https://yandex.com/dev/webmaster/doc/en/reference/user.md) method.
<!-- endsource: en/_includes/popups.md -->
||
||
`host-id`
|
<!-- source: en/_includes/popups.md -->
Type: `host id (string)`. The site ID. To get it, use the [GET /v4/user/{user-id}/hosts](https://yandex.com/dev/webmaster/doc/en/reference/hosts.md) method.
<!-- endsource: en/_includes/popups.md -->
||
||
`parent_id`
|
The parent Sitemap ID.
||
||
`limit`
|
Page size (1-100). Default value: 10.
||
||
`from`
|
Get Sitemap files starting after the specified one (not including it).
||
|#

## Response format {#response-format}

If successful, the server returns 200 OK and the list of the site's Sitemap files.

### Examples

> 
> {% list tabs %}
> 
> - JSON
> 
>   
>   ```javascript
>   {
>     "sitemaps": [
>       {
>         "sitemap_id": "c7-fe:80-c0",
>         "sitemap_url": "some url",
>         "last_access_date": "2016-01-01T00:00:00,000+0300",
>         "errors_count": 1,
>         "urls_count": 1,
>         "children_count": 1,
>         "sources": [
>           "ROBOTS_TXT"
>         ], ...
>         "sitemap_type": "SITEMAP"
>       }, ...
>     ]
>   }
>   ```
>   
> 
> - XML
> 
>   
>   ```xml
>   <Data>
>       <sitemap>
>           <[sitemap_id](*sitemap_id_desc)>c7-fe:80-c0</sitemap_id>
>           <[sitemap_url](*sitemap_url)>some url</sitemap_url>
>           <[last_access_date](*last_access_date)>2016-01-01T00:00:00,000+0300</last_access_date>
>           <[errors_count](*errors_count)>1</errors_count>
>           <[urls_count](*urls_count)>1</urls_count>
>           <[children_count](*children_count)>1</children_count>
>           <[source](*source)>[ROBOTS_TXT](*ROBOTS_TXT)</source>
>           ...
>           <[sitemap_type](*sitemap_type)>[SITEMAP](*SITEMAP)</sitemap_type>
>       </sitemap>
>       ...
>   </Data>
>   ```
> 
> {% endlist %}
>
> #|
> || **Name** | **Required** | **Type** | **Description** ||
> || `sitemap_id` | Yes | `string` | ID of the Sitemap file. ||
> || `sitemap_url` | Yes | `string` | The Sitemap URL. ||
> || `last_access_date` | No | `datetime` | Date the file was last uploaded. ||
> || `errors_count` | Yes | `int32` | The number of errors in the file. ||
> || `urls_count` | Yes | `int64` | The number of links in the file. ||
> || `children_count` | Yes | `int32` | The number of child Sitemap files. ||
> || `source` | Yes | `string` ([ApiSitemapSource](#sitemap-source)) | The sources that led the robot to this file. ||
> || `sitemap_type` | Yes | `string` ([ApiSitemapType](#sitemap-type)) | Type of the Sitemap file. ||
> |#

<!-- source: en/_includes/reference/sitemap-source.md -->
### Source of the Sitemap file (ApiSitemapSource) {#sitemap-source}

#|
|| **Source** | **Description** ||
|| `ROBOTS_TXT` | Sitemap is specified in the site's `robots.txt` file. ||
|| `WEBMASTER` | The user added the Sitemap in Yandex.Webmaster. ||
|| `INDEX_SITEMAP` | Sitemap found in another (index) `Sitemap` file. ||
|#
<!-- endsource: en/_includes/reference/sitemap-source.md -->

<!-- source: en/_includes/reference/sitemap-type.md -->
### Type of Sitemap file (ApiSitemapType) {#sitemap-type}

#|
|| **Type** | **Description** ||
|| `SITEMAP` | Normal `Sitemap` file that contains the URLs of site pages. ||
|| `INDEX_SITEMAP` | The `Sitemap` index file that contains the URLs of other `Sitemap` files. ||
|#
<!-- endsource: en/_includes/reference/sitemap-type.md -->


## Response codes

To view the response structure in detail, click the reason.

#|
||
**Code** | **Reason** | **Description**
||
||
200 | OK | 
||
||
403
|
[INVALID_USER_ID](https://yandex.com/dev/webmaster/doc/en/reference/errors.md#invalid-user-id)
|
The ID of the user who issued the token differs from the one specified in the request. In the examples below, `{user_id}` shows the correct `uid` of the OAuth token owner.

{% list tabs %}

- JSON

  ```json 
  {   
      "error_code": "INVALID_USER_ID",   
      "available_user_id": 1,   
      "error_message": "Invalid user id. {user_id} should be used." 
  }
  ```

- XML

  ```xml 
  <Data>     
      <[error_code](*error_code)>INVALID_USER_ID</error_code>     
      <[available_user_id](*available_user_id)>1</available_user_id>     
      <[error_message](*error_message)>Invalid user id. {user_id} should be used.</error_message> 
  </Data>
  ```

{% endlist %}
||
||
404
|
[HOST_NOT_VERIFIED](https://yandex.com/dev/webmaster/doc/en/reference/errors.md#host-not-verif)
|
Site management rights are not verified.

{% list tabs %}

- JSON

  ```json
  {   
      "error_code": "HOST_NOT_VERIFIED",  
      "host_id": "http:ya.ru:80",   
      "error_message": "some string"
  }
  ```

- XML

  ```xml 
  <Data>   
      <[error_code](*error_code)>HOST_NOT_VERIFIED</error_code>     
      <[host_id](*host_id)>http:ya.ru:80</host_id>   
      <[error_message](*error_message)>some string</error_message> 
  </Data>
  ```

{% endlist %}
||
|#

### Related information

- [Error codes and statuses](https://yandex.com/dev/webmaster/doc/en/reference/errors.md)




[*user-id]: Type: `int64`. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the [GET /v4/user](https://yandex.com/dev/webmaster/doc/en/reference/user.md) method.

[*host-id]: Type: `host id (string)`. The site ID. To get it, use the [GET /v4/user/{user-id}/hosts](https://yandex.com/dev/webmaster/doc/en/reference/hosts.md) method.

[*parent_id]: The parent Sitemap ID.

[*limit]: Page size (1-100). Default value: 10.

[*from]: Get Sitemap files starting after the specified one (not including it).

[*error_code]: **Description**

Error code.

[*available_user_id]: **Description**

ID of the user who allowed access.

[*host_id]: **Description**

ID of the requested site.

[*error_message]: **Description**

Error message.

[*sitemap_id_desc]: **Required**

Yes

**Type**

`string`

**Description**

ID of the Sitemap file.

[*sitemap_url]: **Required**

Yes

**Type**

`string`

**Description**

The Sitemap URL.

[*last_access_date]: **Required**

No

**Type**

`datetime`

**Description**

Date the file was last uploaded.

[*errors_count]: **Required**

Yes

**Type**

`int32`

**Description**

The number of errors in the file.

[*urls_count]: **Required**

Yes

**Type**

`int64`

**Description**

The number of links in the file.

[*children_count]: **Required**

Yes

**Type**

`int32`

**Description**

The number of child Sitemap files.

[*source]: **Required**

Yes

**Type**

`string` ([ApiSitemapSource](#sitemap-source))

**Description**

The sources that led the robot to this file.

[*sitemap_type]: **Required**

Yes

**Type**

`string` ([ApiExplicitVerificationType](#sitemap-type))

**Description**

Type of the Sitemap file.

[*ROBOTS_TXT]: ### Source of the Sitemap file (ApiSitemapSource) {#sitemap-source}

#|
|| **Source** | **Description** ||
|| `ROBOTS_TXT` | Sitemap is specified in the site's `robots.txt` file. ||
|| `WEBMASTER` | The user added the Sitemap in Yandex.Webmaster. ||
|| `INDEX_SITEMAP` | Sitemap found in another (index) `Sitemap` file. ||
|#

[*SITEMAP]: ### Type of Sitemap file (ApiSitemapType) {#sitemap-type}

#|
|| **Type** | **Description** ||
|| `SITEMAP` | Normal `Sitemap` file that contains the URLs of site pages. ||
|| `INDEX_SITEMAP` | The `Sitemap` index file that contains the URLs of other `Sitemap` files. ||
|#