---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
vcsPath: >-
  motorway/magacg/support/docs/src/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md
alternate:
  - href: >-
      https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md
    type: text/markdown
    title: Markdown version
  - href: https://yamagistrali.ru/docs/ru-x-ai/llms.txt
    rel: describedby
---
<div class="openapi">

# Получить список стран

<!-- markdownlint-disable-file -->

[Порядок работы для агента](https://yamagistrali.ru/docs/ru-x-ai/concepts/agent-workflow.md) · [Методы API и схема OpenAPI](https://yamagistrali.ru/docs/ru-x-ai/methods/index.md).

## Назначение

Получите справочник стран, чтобы выбрать значение для поля страны в запросе.

> Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде `example` показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://partner-test-yamagistrali.ru/api/dicts/countries/v0/countriesGet
```

</div>

Тестовый стенд

</div>

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "data": {
    "countries": [
      {
        "countryCode": "example",
        "defaultCurrencyISO": "example",
        "defaultPosition": {
          "lat": 0.5,
          "long": 0.5
        },
        "defaultTimeZone": "example",
        "title": "example"
      }
    ]
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DictsCountriesV0CountriesGetResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-DictsCountriesV0CountriesGetResponse)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "countries": [
    {
      "countryCode": "example",
      "defaultCurrencyISO": "example",
      "defaultPosition": {
        "lat": 0.5,
        "long": 0.5
      },
      "defaultTimeZone": "example",
      "title": "example"
    }
  ]
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### CountriesGetDefaultPosition {#entity-CountriesGetDefaultPosition}

#|
|| **Name** | **Description** ||
||

_lat_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
||

_long_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "lat": 0.5,
  "long": 0.5
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CountryItem {#entity-CountryItem}

#|
|| **Name** | **Description** ||
||

_countryCode_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_defaultCurrencyISO_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_defaultPosition_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [CountriesGetDefaultPosition](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-CountriesGetDefaultPosition)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "lat": 0.5,
  "long": 0.5
}
```

{% endcut %}
{.table-cell}
||
||

_defaultTimeZone_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "countryCode": "example",
  "defaultCurrencyISO": "example",
  "defaultPosition": {
    "lat": 0.5,
    "long": 0.5
  },
  "defaultTimeZone": "example",
  "title": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DictsCountriesV0CountriesGetResponse {#entity-DictsCountriesV0CountriesGetResponse}

#|
|| **Name** | **Description** ||
||

_countries_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CountryItem](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-CountryItem)[] &#124; null

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "countryCode": "example",
    "defaultCurrencyISO": "example",
    "defaultPosition": {
      "lat": 0.5,
      "long": 0.5
    },
    "defaultTimeZone": "example",
    "title": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "countries": [
    {
      "countryCode": "example",
      "defaultCurrencyISO": "example",
      "defaultPosition": {
        "lat": 0.5,
        "long": 0.5
      },
      "defaultTimeZone": "example",
      "title": "example"
    }
  ]
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad Request

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### Error {#entity-Error}

#|
|| **Name** | **Description** ||
||

_info_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: object

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_message_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

Forbidden

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal Server Error

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.