## Получить список значений справочника CRM

`GET /v1/crm-dictionaries/:dictionary`

Возвращает страницу значений выбранного справочника CRM для настройки дел, контактных данных и стадий.

> **Доступность.** Возможность включается администратором и требует обновления CRM после версии 26.2200.0. Номер выпущенной версии ещё не определён. Если возможность недоступна, API возвращает `422 METHOD_NOT_YET_AVAILABLE` с полем `error.release`.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
| `dictionary` (path) | string | да | — | `activity-providers`, `email-types`, `phone-types`, `im-types`, `web-types`, `stage-semantics` |
| `limit` (query) | integer | нет | `50` | Размер страницы от 1 до 1000 |
| `offset` (query) | integer | нет | `0` | Количество пропускаемых записей, неотрицательное целое |

Для следующей страницы увеличьте `offset` на `limit`. Ответ содержит одну страницу без общего количества записей.

## Примеры

### curl — личный ключ

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const result = await res.json()
console.log(result)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const result = await res.json()
console.log(result)
```

## Поля ответа

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` |
| `data` | array | Значения справочника |
| `data[].id` | string | ID для [чтения значения](/docs/entities/crm-v3-dictionaries/get) |
| `data[].name` | string \| null | Название. `null` допустим для типов контактных данных |
| `data[].nameShort` | string \| null | Краткое название, только типы контактных данных |
| `data[].isDeprecated` | boolean | Устарел ли тип контактных данных |
| `data[].isAvailable` | boolean | Доступен ли поставщик дел, только `activity-providers` |
| `data[].isActive` | boolean | Активен ли поставщик дел |
| `data[].types` | array | Типы дел поставщика |
| `data[].types[].providerTypeId` | string | ID типа дела из этого массива |
| `data[].types[].name` | string | Название типа дела |
| `data[].types[].directions` | object | Направления типа дела |
| `data[].defaultTypeId` | string \| null | Тип дела по умолчанию, из `types[].providerTypeId` |
| `data[].capabilities` | string[] | Возможности поставщика дел |
| `meta.limit` | integer | Запрошенный размер страницы |
| `meta.offset` | integer | Запрошенный отступ |

Поля `types`, `defaultTypeId`, `capabilities`, `isAvailable`, `isActive` относятся только к `activity-providers`. Для `stage-semantics` элемент содержит `id` и `name`.

## Пример ответа

```json
{
  "success": true,
  "data": [
    {
      "id": "WORK",
      "name": "Рабочий e-mail",
      "nameShort": "Рабочий",
      "isDeprecated": false
    },
    {
      "id": "HOME",
      "name": "Частный e-mail",
      "nameShort": "Частный",
      "isDeprecated": false
    }
  ],
  "meta": {
    "limit": 2,
    "offset": 0
  }
}
```

## Пример ответа при ошибке

400 — некорректный размер страницы:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "limit must be positive and offset nonnegative safe integers"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `INVALID_PARAMS` | Некорректный тип или форма параметра |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный или повторяющийся параметр запроса |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | У ключа нет токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `crm` |
| 403 | `BITRIX_ACCESS_DENIED` | Нет права на операцию в Битрикс24 |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Возможность выключена или недоступна на портале. Целевое обновление указано в `error.release` |
| 422 | `BITRIX_ERROR` | Отказ Битрикс24. Причина в `error.message` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул некорректный ответ |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Смотрите также

- [Получить значение справочника](/docs/entities/crm-v3-dictionaries/get)
- [Справочники CRM и настройки стадий](/docs/entities/crm-v3-dictionaries)