[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-scrum\u002Fepics":3,"docs-tabs-scrum\u002Fepics":6},{"content":4,"lastmod":5},"# Эпики скрама\n\nСоздание, чтение, переименование и перекраска эпиков скрам-проекта. Эпик группирует задачи внутри одной рабочей группы Битрикс24. Задачи привязываются к эпику через [размещение задачи в скраме](\u002Fdocs\u002Fscrum).\n\n**Скоуп:** `task` | **Базовый URL:** `https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1` | **Авторизация:** `X-Api-Key`\n\n## Операции\n\n- [Создать эпик](.\u002Fepics\u002Fcreate.md) — `POST \u002Fv1\u002Fscrum\u002Fepics`\n- [Список эпиков](.\u002Fepics\u002Flist.md) — `GET \u002Fv1\u002Fscrum\u002Fepics`\n- [Получить эпик](.\u002Fepics\u002Fget.md) — `GET \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n- [Обновить эпик](.\u002Fepics\u002Fupdate.md) — `PATCH \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\n## Смотрите также\n\n- [Scrum](\u002Fdocs\u002Fscrum) — обзор раздела и размещение задач\n- [Рабочие группы](\u002Fdocs\u002Fentities\u002Fworkgroups) — источник `groupId` скрам-проекта\n","2026-06-23",{"epics\u002Fcreate.md":7,"epics\u002Flist.md":8,"epics\u002Fget.md":9,"epics\u002Fupdate.md":10},"## Создать эпик\n\n`POST \u002Fv1\u002Fscrum\u002Fepics`\n\nСоздаёт эпик в скрам-проекте. Тело плоское, без обёртки `fields`.\n\n## Поля запроса (body)\n\n| Поле | Тип | Обяз. | Описание |\n|------|-----|:-----:|---------|\n| `name` | string | да | Название эпика. До 65 535 символов |\n| `groupId` | number | да | ID скрам-проекта (рабочей группы). Список: `GET \u002Fv1\u002Fworkgroups` |\n| `description` | string | нет | Описание эпика. До 65 535 символов |\n| `color` | string | нет | Цвет эпика, например `\"#5eead4\"`. До 64 символов |\n| `createdBy` | number | нет | ID автора. По умолчанию — пользователь, которому принадлежит ключ. Список: `GET \u002Fv1\u002Fusers` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"doc-verify create\",\n    \"groupId\": 45,\n    \"description\": \"Зеркало эпика из внешнего трекера\",\n    \"color\": \"#5eead4\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"doc-verify create\",\n    \"groupId\": 45,\n    \"description\": \"Зеркало эпика из внешнего трекера\",\n    \"color\": \"#5eead4\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    name: 'doc-verify create',\n    groupId: 45,\n    description: 'Зеркало эпика из внешнего трекера',\n    color: '#5eead4',\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Epic ID:', data.id)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    name: 'doc-verify create',\n    groupId: 45,\n    description: 'Зеркало эпика из внешнего трекера',\n    color: '#5eead4',\n  }),\n})\n\nconst { data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `id` | number | ID созданного эпика |\n| `groupId` | number | ID скрам-проекта |\n| `name` | string | Название эпика |\n| `description` | string | Описание эпика |\n| `color` | string | Цвет эпика |\n| `createdBy` | number | ID автора |\n| `modifiedBy` | number | ID последнего изменившего. На создании равен `0` |\n\n## Пример ответа\n\n```json\n{\n    \"success\": true,\n    \"data\": {\n        \"id\": 11,\n        \"groupId\": 45,\n        \"name\": \"doc-verify create\",\n        \"description\": \"Зеркало эпика из внешнего трекера\",\n        \"createdBy\": 1,\n        \"modifiedBy\": 0,\n        \"color\": \"#5eead4\"\n    }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — нарушена валидация:\n\n```json\n{\n    \"success\": false,\n    \"error\": {\n        \"code\": \"INVALID_PARAMS\",\n        \"message\": \"name is required\"\n    }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Не передан `name` или `groupId`, либо значение неверного типа |\n| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку при создании эпика, например скрам-проекта с указанным `groupId` не существует |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение |\n| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n- **Доступ.** Создавать эпики может только пользователь Битрикс24, от имени которого работает ключ, с доступом к скрам-проекту. Иначе портал вернёт `422 BITRIX_ERROR` с сообщением «Access denied».\n\n## Смотрите также\n\n- [Список эпиков](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Получить эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [Обновить эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fupdate)\n- [Рабочие группы](\u002Fdocs\u002Fentities\u002Fworkgroups)\n- [Scrum](\u002Fdocs\u002Fscrum)\n","## Список эпиков\n\n`GET \u002Fv1\u002Fscrum\u002Fepics`\n\nВозвращает эпики скрам-проектов портала, опционально по конкретному скрам-проекту.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | По умолч. | Описание |\n|----------|-----|:-----:|-----------|---------|\n| `groupId` (query) | number | нет | — | Фильтр по скрам-проекту. Список: `GET \u002Fv1\u002Fworkgroups` |\n| `limit` (query) | number | нет | 200 | Максимум эпиков в ответе. Максимум 1000 |\n\nПри `limit > 50` API автоматически докачивает записи и возвращает их одним массивом, поэтому портал с более чем 50 эпиками выгружается полностью.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics?groupId=45\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics?groupId=45\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics?groupId=45', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\nconst { data } = await res.json()\nconsole.log('Эпиков:', data.length)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics?groupId=45', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\nconst { data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | array | Массив эпиков |\n| `data[].id` | number | Идентификатор эпика |\n| `data[].groupId` | number | Скрам-проект эпика. Список: `GET \u002Fv1\u002Fworkgroups` |\n| `data[].name` | string | Название эпика |\n| `data[].description` | string | Описание эпика |\n| `data[].createdBy` | number | Автор эпика. Список: `GET \u002Fv1\u002Fusers` |\n| `data[].modifiedBy` | number | Кто изменил эпик последним. `0`, если изменений не было. Список: `GET \u002Fv1\u002Fusers` |\n| `data[].color` | string | Цвет эпика в формате HEX |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 3,\n      \"groupId\": 45,\n      \"name\": \"Авторизация\",\n      \"description\": \"\",\n      \"createdBy\": 29,\n      \"modifiedBy\": 0,\n      \"color\": \"#c4baed\"\n    },\n    {\n      \"id\": 5,\n      \"groupId\": 45,\n      \"name\": \"Платежи\",\n      \"description\": \"\",\n      \"createdBy\": 29,\n      \"modifiedBy\": 0,\n      \"color\": \"#ffcbd8\"\n    },\n    {\n      \"id\": 7,\n      \"groupId\": 45,\n      \"name\": \"Отчёты\",\n      \"description\": \"Сводные отчёты по спринтам\",\n      \"createdBy\": 1,\n      \"modifiedBy\": 1,\n      \"color\": \"#69dafc\"\n    }\n  ]\n}\n```\n\n## Пример ответа при ошибке\n\n400 — нарушена валидация:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"groupId must be a positive integer\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `groupId` или `limit` не является положительным целым числом |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |\n| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Получить эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [Создать эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fcreate)\n- [Эпики скрама](\u002Fdocs\u002Fscrum\u002Fepics)\n- [Рабочие группы](\u002Fdocs\u002Fentities\u002Fworkgroups)\n","## Получить эпик\n\n`GET \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\nВозвращает один эпик скрам-проекта по его идентификатору.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | Идентификатор эпика. Список: `GET \u002Fv1\u002Fscrum\u002Fepics` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F7 \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F7 \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F7', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\nconst { data } = await res.json()\nconsole.log('Эпик:', data.name)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F7', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\nconst { data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.id` | number | Идентификатор эпика |\n| `data.groupId` | number | Скрам-проект эпика. Список: `GET \u002Fv1\u002Fworkgroups` |\n| `data.name` | string | Название эпика |\n| `data.description` | string | Описание эпика |\n| `data.createdBy` | number | Автор эпика. Список: `GET \u002Fv1\u002Fusers` |\n| `data.modifiedBy` | number | Кто изменил эпик последним. `0`, если изменений не было. Список: `GET \u002Fv1\u002Fusers` |\n| `data.color` | string | Цвет эпика в формате HEX |\n| `data.files` | array | ID вложений эпика, например `[417]` |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 7,\n    \"groupId\": 45,\n    \"name\": \"Отчёты\",\n    \"description\": \"Сводные отчёты по спринтам\",\n    \"createdBy\": 1,\n    \"modifiedBy\": 1,\n    \"color\": \"#69dafc\",\n    \"files\": [417]\n  }\n}\n```\n\nУ эпика без вложений `files` — пустой массив `[]`.\n\n## Пример ответа при ошибке\n\n404 — не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Epic not found\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `id` не является положительным целым числом |\n| 404 | `ENTITY_NOT_FOUND` | Эпика с указанным `id` нет |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |\n| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Список эпиков](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Обновить эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fupdate)\n- [Эпики скрама](\u002Fdocs\u002Fscrum\u002Fepics)\n- [Рабочие группы](\u002Fdocs\u002Fentities\u002Fworkgroups)\n","## Обновить эпик\n\n`PATCH \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\nЧастично обновляет эпик скрам-проекта: переименование, перекраска, смена описания или скрам-проекта. Тело плоское, без обёртки `fields`.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID эпика |\n\n## Поля запроса (body)\n\nПередавайте только изменяемые поля. Нужно хотя бы одно из перечисленных.\n\n| Поле | Тип | Обяз. | Описание |\n|------|-----|:-----:|---------|\n| `name` | string | нет | Новое название эпика. До 65 535 символов |\n| `groupId` | number | нет | Новый ID скрам-проекта. Список: `GET \u002Fv1\u002Fworkgroups` |\n| `description` | string | нет | Новое описание. До 65 535 символов |\n| `color` | string | нет | Новый цвет эпика, например `\"#5eead4\"`. До 64 символов |\n| `modifiedBy` | number | нет | ID изменившего эпик. Список: `GET \u002Fv1\u002Fusers` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F9 \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"doc-verify epic\",\n    \"description\": \"x\",\n    \"color\": \"#5eead4\",\n    \"modifiedBy\": 1\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F9 \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"doc-verify epic\",\n    \"description\": \"x\",\n    \"color\": \"#5eead4\",\n    \"modifiedBy\": 1\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F9', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    name: 'doc-verify epic',\n    description: 'x',\n    color: '#5eead4',\n    modifiedBy: 1,\n  }),\n})\n\nconst { data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fscrum\u002Fepics\u002F9', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    name: 'doc-verify epic',\n    description: 'x',\n    color: '#5eead4',\n    modifiedBy: 1,\n  }),\n})\n\nconst { data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `id` | number | ID эпика |\n| `groupId` | number | ID скрам-проекта |\n| `name` | string | Название эпика |\n| `description` | string | Описание эпика |\n| `color` | string | Цвет эпика |\n| `createdBy` | number | ID автора |\n| `modifiedBy` | number | ID последнего изменившего |\n\n## Пример ответа\n\n```json\n{\n    \"success\": true,\n    \"data\": {\n        \"id\": 9,\n        \"groupId\": 45,\n        \"name\": \"doc-verify epic\",\n        \"description\": \"x\",\n        \"createdBy\": 1,\n        \"modifiedBy\": 1,\n        \"color\": \"#5eead4\"\n    }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — нарушена валидация:\n\n```json\n{\n    \"success\": false,\n    \"error\": {\n        \"code\": \"INVALID_PARAMS\",\n        \"message\": \"At least one of name, groupId, description, color, createdBy, modifiedBy is required\"\n    }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Пустое тело, нечисловой `id`, неверный тип поля или передан `createdBy` |\n| 404 | `ENTITY_NOT_FOUND` | Эпика с указанным `id` не существует |\n| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку при обновлении эпика |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение |\n| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`createdBy` задаётся только при создании.** В обновлении это поле отклоняется с `400 INVALID_PARAMS` и сообщением «createdBy can only be set on create». Авторство переносить нельзя — для записи изменившего используйте `modifiedBy`.\n\n## Смотрите также\n\n- [Создать эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fcreate)\n- [Получить эпик](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [Список эпиков](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Рабочие группы](\u002Fdocs\u002Fentities\u002Fworkgroups)\n- [Scrum](\u002Fdocs\u002Fscrum)\n"]