## Получить шаблон документа CRM

`GET /v1/crm-document-templates/:id`

Возвращает один шаблон документа CRM по идентификатору вместе с типами записей, к которым он привязан, и кодами доступа сотрудников.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | Идентификатор шаблона, положительное целое число. Список: [`GET /v1/crm-document-templates`](/docs/entities/crm-document-templates/list) |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-document-templates/87" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-document-templates/87" \
  -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-document-templates/87', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Шаблон:', data.name, 'привязан к:', data.entityTypeId)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-document-templates/87', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Шаблон |
| `data.id` | string | Идентификатор шаблона |
| `data.name` | string | Название |
| `data.region` | string | Регион шаблона, например `ru` |
| `data.code` | string \| null | Символьный код шаблона |
| `data.active` | string | Доступность: `Y` / `N` |
| `data.moduleId` | string | Модуль-владелец, в этом разделе всегда `crm` |
| `data.numeratorId` | string | ID нумератора, который присваивает номера документам |
| `data.withStamps` | string | Печати и подписи: `Y` / `N` |
| `data.users` | object | Коды доступа сотрудников, которым виден шаблон. Ключ и значение совпадают и равны коду доступа, например `{"UA": "UA"}` — все сотрудники |
| `data.isDeleted` | string | Помечен ли шаблон удалённым: `Y` / `N` |
| `data.sort` | string | Порядок в списке |
| `data.createTime` | string | Дата создания в ISO 8601 |
| `data.updateTime` | string | Дата изменения в ISO 8601 |
| `data.entityTypeId` | array | Типы записей CRM, к которым привязан шаблон, строками: `1` — лид, `3` — контакт, `4` — компания. Сделка раскрыта по воронкам — `2_category_0`, `2_category_1` и так далее, подробнее в разделе [Шаблоны документов CRM](/docs/entities/crm-document-templates). Смарт-процесс с воронками приходит в форме `174_3`: тип смарт-процесса и ID его воронки. Типы смарт-процессов: [`GET /v1/smart-processes`](/docs/entities/smart-processes) |
| `data.download` | string | Адрес скачивания файла шаблона в веб-интерфейсе Битрикс24. Для скачивания через API используйте `downloadMachine` |
| `data.downloadMachine` | string | Ссылка на скачивание файла шаблона через API Вайбкод — [`GET /v1/crm-document-templates/:id/download`](/docs/entities/crm-document-templates/download) |

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

```json
{
  "success": true,
  "data": {
    "id": "87",
    "name": "Адреса",
    "region": "ru",
    "code": null,
    "download": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=87",
    "active": "Y",
    "moduleId": "crm",
    "numeratorId": "1",
    "withStamps": "Y",
    "users": {
      "UA": "UA"
    },
    "isDeleted": "N",
    "sort": "366",
    "createTime": "2022-11-23T14:42:12+03:00",
    "updateTime": "2023-01-17T11:36:04+03:00",
    "entityTypeId": [
      "4",
      "3",
      "2_category_0",
      "2_category_1",
      "2_category_3",
      "174_3",
      "177_7",
      "177_9",
      "185_11",
      "1",
      "31_5"
    ],
    "downloadMachine": "https://vibecode.bitrix24.tech/v1/crm-document-templates/87/download"
  }
}
```

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

404 — шаблон не найден:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "CRM template not found."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | Шаблона с таким `id` нет на портале |
| 404 | `ENTITY_NOT_FOUND` | Шаблон с таким `id` есть, но его `moduleId` отличен от `crm`, например шаблон приложения. Шаблоны приложений читает [`GET /v1/doc-templates/:id`](/docs/entities/doc-templates/get) |
| 400 | `INVALID_PARAMS` | `id` не является положительным целым числом |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил чтение шаблона. Текст причины — в `error.message` |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `crm` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |
| 429 | `RATE_LIMITED` | Битрикс24 ограничил частоту запросов к порталу. Повторите после срока из заголовка `Retry-After` |

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

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

- [Список шаблонов документов CRM](/docs/entities/crm-document-templates/list)
- [Получить шаблоны для записи CRM](/docs/entities/crm-document-templates/available)
- [Обновить шаблон документа CRM](/docs/entities/crm-document-templates/update)
- [Скачать шаблон](/docs/entities/crm-document-templates/download)
- [Шаблоны документов CRM](/docs/entities/crm-document-templates)