---
metadata:
  - name: generator
    content: Diplodoc Platform v5.44.0
alternate:
  - https://yandex.ru/dev/webmaster/doc/en/reference/host-user-added-sitemaps-get.md
  - https://yandex.ru/dev/webmaster/doc/ru/reference/host-user-added-sitemaps-get.md
keywords:
  - s
  - i
  - t
  - e
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/webmaster/doc/en/llms.txt


# Getting the list of Sitemap files added by the user

Returns the list of Sitemap files added by the user.

## Request format

```
GET https://api.webmaster.yandex.net/v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/user-added-sitemaps
  ? [[offset](*offset)=<sitemap id>]
  & [[limit](*limit)=<int 32>]
```



#|
||
`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.ru/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.ru/dev/webmaster/doc/en/reference/hosts.md) method.
<!-- endsource: en/_includes/popups.md -->
||
||
`offset`
|
Get files starting from the specified one (not including it). Default value: 0.
||
||
`limit`
|
Page size (1-100). Default value: 100.
||
|#

## Response format

### Examples

> 
> {% list tabs %}
> 
> - JSON
> 
>   
>   ```javascript
>   {
>     "sitemaps": [
>       {
>         "sitemap_id": "c7-fe:80-c0",
>         "sitemap_url": "some url",
>         "added_date": "2016-01-01T00:00:00,000+0300"
>       }, ...
>     ],
>     "count": 1
>   }
>   ```
>   
> 
> - XML
> 
>   
>   ```xml
>   <Data>
>     <sitemap>
>           <[sitemap_id](*sitemap_id_desc)>c7-fe:80-c0</sitemap_id>
>           <[sitemap_url](*sitemap_url)>some url</sitemap_url>
>           <[added_date](*added_date)>2016-01-01T00:00:00,000+0300</added_date>
>     </sitemap>
>     ...
>     <[count](*count_desc_2)>1</count>
>   </Data>
>   ```
> 
> {% endlist %}

#|
|| **Name** | **Required** | **Type** | **Description** ||
|| `sitemap_id` | Yes | `string` | The Sitemap file ID. ||
|| `sitemap_url` | Yes | `string` | The Sitemap URL. ||
|| `added_date` | Yes | `datetime` | Date the file was added. ||
|| `count` | Yes | `int32` | Total number of Sitemap files added by the user. ||
|#

## Response codes

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

#|
||
**Code** | **Reason** | **Description**
||
||
200 | OK | 
||
||
403
|
[INVALID_USER_ID](https://yandex.ru/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.ru/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.ru/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.ru/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.ru/dev/webmaster/doc/en/reference/hosts.md) method.

[*offset]: Get files starting from the specified one (not including it). Default value: 0.

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

[*sitemap_id_desc]: **Required**

Yes

**Type**

`string`

**Description**

ID of the Sitemap file.

[*sitemap_url]: **Required**

Yes

**Type**

`string`

**Description**

The Sitemap URL.

[*added_date]: **Required**

Yes

**Type**

`datetime`

**Description**

Date the file was added.

[*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.

[*count_desc_2]: **Required**

Yes

**Type**

`int32`

**Description**

Total number of Sitemap files added by the user.