---
metadata:
  - name: generator
    content: Diplodoc Platform v5.55.2
alternate:
  - https://yandex.com/dev/webmaster/doc/en/reference/host-user-added-sitemaps-sitemap-id-get.md
  - https://yandex.com/dev/webmaster/doc/ru/reference/host-user-added-sitemaps-sitemap-id-get.md
  - href: en/reference/host-user-added-sitemaps-sitemap-id-get.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
keywords: site
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/webmaster/doc/en/llms.txt


# Getting information about the Sitemap added by the user

Returns detailed information about a Sitemap file added by the user, including the file type, date and method used for uploading the file to Yandex.Webmaster, the date the service processed the file, the number of URLs in the file and the number and type of errors found.

## Request format

```
GET https://api.webmaster.yandex.net/v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/user-added-sitemaps/{[sitemap-id](*sitemap-id)}
```



#|
||
`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 -->
||
||
`sitemap-id`
|
Type: `sitemap id (string)`. [Sitemap file ID](https://yandex.com/dev/webmaster/doc/en/reference/host-sitemaps-get.md#response-format).
||
|#

## Response format

### Examples

> 
> {% list tabs %}
> 
> - JSON
> 
>   
>   ```javascript
>   {
>     "sitemap_id": "c7-fe:80-c0",
>     "sitemap_url": "some url",
>     "added_date": "2016-01-01T00:00:00,000+0300"
>   }
>   ```
>   
> 
> - XML
> 
>   
>   ```xml
>   <Data>
>       <[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>
>   </Data>
>   ```
> 
> {% endlist %}

#|
|| **Name** | **Required** | **Type** | **Description** ||
|| `sitemap_id` | Yes | `string` | The sitemap file ID. ||
|| `sitemap_url` | Yes | `string` | The sitemap file URL. ||
|| `added_date` | Yes | `datetime` | Date the file was last uploaded. ||
|#

## 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 %}
||
||
404
|
[SITEMAP_NOT_ADDED](https://yandex.com/dev/webmaster/doc/en/reference/errors.md#sitemap-not-added)
|
The Sitemap file is missing.

{% list tabs %}

- JSON

  ```javascript 
  {   
      "error_code": "SITEMAP_NOT_ADDED",   
      "host_id": "http:ya.ru:80",   
      "sitemap_id": "c7-fe:80-c0",   
      "error_message": "some string"
  }
  ```

- XML

  ```xml 
  <Data>   
      <[error_code](*error_code)>SITEMAP_NOT_ADDED</error_code>    
      <[host_id](*host_id)>http:ya.ru:80</host_id>     
      <[sitemap_id](*sitemap_id)>c7-fe:80-c0</sitemap_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.

[*sitemap-id]: Type: sitemap id (string). [Sitemap file ID](https://yandex.com/dev/webmaster/doc/en/reference/host-sitemaps-get.md#response-format).

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

[*sitemap_id]: **Description**

The `Sitemap` file ID.

[*error_message]: **Description**

Error message.