---
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:
  - с
  - а
  - й
  - т
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/webmaster/doc/ru/llms.txt


# Получение списка файлов Sitemap, добавленных пользователем

Возвращает список файлов Sitemap, добавленных пользователем.

## Формат запроса {#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-param)=<int 32>]
```

#|
||
`user-id`
|
    
<!-- source: ru/_includes/popup/user-id.md -->
Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.ru/dev/webmaster/doc/ru/reference/user.md).
<!-- endsource: ru/_includes/popup/user-id.md -->
    
||
||
`host-id`
|
    
<!-- source: ru/_includes/popup/host-id.md -->
Тип: `string`. ID сайта. Чтобы получить его, используйте метод [GET&nbsp;/v4/user/{user&#x2011;id}/hosts](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts.md).
<!-- endsource: ru/_includes/popup/host-id.md -->

||
||
`offset`
|
<!-- source: ru/_includes/popup/offset-param2.md -->
Получить файлы, отсчитывая от указанного (исключительно). Значение по умолчанию: 0.
<!-- endsource: ru/_includes/popup/offset-param2.md -->
||
||
`limit`
|
<!-- source: ru/_includes/popup/limit-param2.md -->
Количество записей (1-100). Значение по умолчанию: 100.
<!-- endsource: ru/_includes/popup/limit-param2.md -->
||
|#

## Формат ответа {#response-format}

### Примеры
> 
> 
> {% 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_id2)>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)>1</count>
>   </Data>
>   ```
> 
> {% endlist %}

#|
||
**Имя**
|
**Обязательный**
|
**Тип**
|
**Описание**
||
||
`sitemap_id`
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/req.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/type.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/desc.md -->
Идентификатор файла Sitemap.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/desc.md -->
||
||
`sitemap_url`
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/req.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/type.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/desc.md -->
URL файла Sitemap.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/desc.md -->
||
||
`added_date`
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/req.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/type.md -->
`datetime`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/type.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/desc.md -->
Дата добавления файла.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/desc.md -->
||
||
`count`
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/req.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/type.md -->
`int32`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/type.md -->
|
<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/desc.md -->
Общее количество файлов Sitemap, добавленных пользователем.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/desc.md -->
||
|#

## Коды ответа {#errors}


Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

#|

||
**Код**
|
**Причина**
|
**Описание**
||


||
200
|
OK
|
||

||
403
|
[INVALID_USER_ID](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#invalid-user-id)
|
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже `{user_id}` указан правильный `uid` владельца OAuth-токена.


<!-- source: ru/_includes/reference/errors/code-inv-id.md -->
{% 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 %}
<!-- endsource: ru/_includes/reference/errors/code-inv-id.md -->

||


||
404
|
[HOST_NOT_VERIFIED](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#host-not-verif)
|
Не подтверждены права на управление сайтом.

<!-- source: ru/_includes/reference/errors/dl-host-not-ver.md -->
{% 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 %}
<!-- endsource: ru/_includes/reference/errors/dl-host-not-ver.md -->

||
|#

#### Узнайте больше

- [Коды ошибок и статусы](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md)







[*user-id]: Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.ru/dev/webmaster/doc/ru/reference/user.md).

[*host-id]: Тип: `string`. ID сайта. Чтобы получить его, используйте метод [GET&nbsp;/v4/user/{user&#x2011;id}/hosts](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts.md).

[*limit-param]: Количество записей (1-100). Значение по умолчанию: 10.

[*offset]: Получить файлы, отсчитывая от указанного (исключительно). Значение по умолчанию: 0.

[*sitemap_id2]: **Обязательный**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/desc.md -->
Идентификатор файла Sitemap.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_id/desc.md -->

[*sitemap_url]: **Обязательный**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/desc.md -->
URL файла Sitemap.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/sitemap_url/desc.md -->

[*added_date]: **Обязательный**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/type.md -->
`datetime`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/added_date/desc.md -->
Дата добавления файла.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/added_date/desc.md -->

[*count]: **Обязательный**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/type.md -->
`int32`
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-user-added-sitemaps-get/count/desc.md -->
Общее количество файлов Sitemap, добавленных пользователем.
<!-- endsource: ru/_includes/reference/host-user-added-sitemaps-get/count/desc.md -->