[{"data":1,"prerenderedAt":11},["ShallowReactive",2],{"docs-scrum\u002Fepics":3,"docs-tabs-scrum\u002Fepics":6},{"content":4,"lastmod":5},"# Scrum epics\n\nCreate, read, rename and recolor epics in a scrum project. An epic groups tasks within a single Bitrix24 workgroup. Tasks are bound to an epic through [task placement in scrum](\u002Fdocs\u002Fscrum).\n\n**Scope:** `task` | **Base URL:** `https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1` | **Auth:** `X-Api-Key`\n\n## Operations\n\n- [Create an epic](.\u002Fepics\u002Fcreate.md) — `POST \u002Fv1\u002Fscrum\u002Fepics`\n- [List epics](.\u002Fepics\u002Flist.md) — `GET \u002Fv1\u002Fscrum\u002Fepics`\n- [Get an epic](.\u002Fepics\u002Fget.md) — `GET \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n- [Update an epic](.\u002Fepics\u002Fupdate.md) — `PATCH \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\n## See also\n\n- [Scrum](\u002Fdocs\u002Fscrum)\n- [Workgroups](\u002Fdocs\u002Fentities\u002Fworkgroups)\n\n## Delete\n\n`DELETE \u002Fv1\u002Fscrum\u002Fepics\u002F:id` calls `tasks.api.scrum.epic.delete` with the epic `id`. The Bitrix24 result is passed through in `data`.\n","2026-09-28",{"epics\u002Fcreate.md":7,"epics\u002Flist.md":8,"epics\u002Fget.md":9,"epics\u002Fupdate.md":10},"## Create an epic\n\n`POST \u002Fv1\u002Fscrum\u002Fepics`\n\nCreates an epic in a scrum project. The body is flat, with no `fields` wrapper.\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|---------|\n| `name` | string | yes | Epic name. Up to 65,535 characters |\n| `groupId` | number | yes | Scrum project (workgroup) ID. List: `GET \u002Fv1\u002Fworkgroups` |\n| `description` | string | no | Epic description. Up to 65,535 characters |\n| `color` | string | no | Epic color, for example `\"#5eead4\"`. Up to 64 characters |\n| `createdBy` | number | no | Author ID. Defaults to the user the key belongs to. List: `GET \u002Fv1\u002Fusers` |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\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\": \"Mirror of an epic from an external tracker\",\n    \"color\": \"#5eead4\"\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\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\": \"Mirror of an epic from an external tracker\",\n    \"color\": \"#5eead4\"\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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: 'Mirror of an epic from an external tracker',\n    color: '#5eead4',\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Epic ID:', data.id)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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: 'Mirror of an epic from an external tracker',\n    color: '#5eead4',\n  }),\n})\n\nconst { data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | object | The created epic |\n| `data.id` | number | ID of the created epic |\n| `data.groupId` | number | Scrum project ID |\n| `data.name` | string | Epic name |\n| `data.description` | string | Epic description |\n| `data.color` | string | Epic color |\n| `data.createdBy` | number | Author ID |\n| `data.modifiedBy` | number | ID of the last editor. Equals `0` on creation |\n\n## Response example\n\n```json\n{\n    \"success\": true,\n    \"data\": {\n        \"id\": 11,\n        \"groupId\": 45,\n        \"name\": \"doc-verify create\",\n        \"description\": \"Mirror of an epic from an external tracker\",\n        \"createdBy\": 1,\n        \"modifiedBy\": 0,\n        \"color\": \"#5eead4\"\n    }\n}\n```\n\n## Error response example\n\n400 — validation failed:\n\n```json\n{\n    \"success\": false,\n    \"error\": {\n        \"code\": \"INVALID_PARAMS\",\n        \"message\": \"name is required\"\n    }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `name` or `groupId` is missing, or a value has the wrong type |\n| 422 | `BITRIX_ERROR` | Bitrix24 returned an error while creating the epic, for example no scrum project exists with the given `groupId` |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only |\n| 401 | `TOKEN_MISSING` | The key has no configured tokens |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n- **Access.** The Bitrix24 user the key acts as must have access to the scrum project to create epics. Otherwise Bitrix24 returns `422 BITRIX_ERROR` with the message \"Access denied\".\n\n## See also\n\n- [List epics](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Get an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [Update an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fupdate)\n- [Workgroups](\u002Fdocs\u002Fentities\u002Fworkgroups)\n- [Scrum](\u002Fdocs\u002Fscrum)\n","## List epics\n\n`GET \u002Fv1\u002Fscrum\u002Fepics`\n\nReturns the epics of the Bitrix24 account's scrum projects, optionally filtered by a specific scrum project.\n\n## Parameters\n\n| Parameter | Type | Required | Default | Description |\n|----------|-----|:-----:|-----------|---------|\n| `groupId` (query) | number | no | — | Filter by scrum project. List: `GET \u002Fv1\u002Fworkgroups` |\n| `limit` (query) | number | no | 200 | Maximum number of epics in the response. Up to 1000 |\n\nWhen `limit > 50`, the API automatically fetches additional records and returns them as a single array, so all epics are returned even when the Bitrix24 account has more than 50.\n\nThe generic `filter` parameter is not applied by this endpoint. By default, the API preserves the previous HTTP 200 response and data, adds `Warning: 299 - \"filter is not supported on this endpoint and was ignored\"`, and records unsupported-filter use in the server log.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics?groupId=45\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics?groupId=45\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics?groupId=45', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\nconst { data } = await res.json()\nconsole.log('Epics:', data.length)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | array | Array of epics |\n| `data[].id` | number | Epic identifier |\n| `data[].groupId` | number | Epic's scrum project. List: `GET \u002Fv1\u002Fworkgroups` |\n| `data[].name` | string | Epic name |\n| `data[].description` | string | Epic description |\n| `data[].createdBy` | number | Epic author. List: `GET \u002Fv1\u002Fusers` |\n| `data[].modifiedBy` | number | Who edited the epic last. `0` if it was never edited. List: `GET \u002Fv1\u002Fusers` |\n| `data[].color` | string | Epic color in HEX format |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 3,\n      \"groupId\": 45,\n      \"name\": \"Authorization\",\n      \"description\": \"\",\n      \"createdBy\": 29,\n      \"modifiedBy\": 0,\n      \"color\": \"#c4baed\"\n    },\n    {\n      \"id\": 5,\n      \"groupId\": 45,\n      \"name\": \"Payments\",\n      \"description\": \"\",\n      \"createdBy\": 29,\n      \"modifiedBy\": 0,\n      \"color\": \"#ffcbd8\"\n    },\n    {\n      \"id\": 7,\n      \"groupId\": 45,\n      \"name\": \"Reports\",\n      \"description\": \"Summary reports by sprint\",\n      \"createdBy\": 1,\n      \"modifiedBy\": 1,\n      \"color\": \"#69dafc\"\n    }\n  ]\n}\n```\n\n## Error response example\n\n400 — validation failed:\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## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 200 | `Warning: 299` | The filter is ignored by default; previous data is preserved and the warning is sent in the `Warning` header. |\n| 400 (strict mode only) | `UNSUPPORTED_FILTER` | The server mode is disabled by default; until it is enabled, the endpoint preserves HTTP 200 and the previous data. |\n| 400 | `INVALID_PARAMS` | `groupId` or `limit` is not a positive integer |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 401 | `TOKEN_MISSING` | The key has no configured tokens |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Get an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [Create an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fcreate)\n- [Scrum epics](\u002Fdocs\u002Fscrum\u002Fepics)\n- [Workgroups](\u002Fdocs\u002Fentities\u002Fworkgroups)\n","## Get an epic\n\n`GET \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\nReturns a single scrum-project epic by its identifier.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | yes | Epic identifier. List: `GET \u002Fv1\u002Fscrum\u002Fepics` |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics\u002F7 \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics\u002F7 \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fepics\u002F7', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\nconst { data } = await res.json()\nconsole.log('Epic:', data.name)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data.id` | number | Epic identifier |\n| `data.groupId` | number | Epic's scrum project. List: `GET \u002Fv1\u002Fworkgroups` |\n| `data.name` | string | Epic name |\n| `data.description` | string | Epic description |\n| `data.createdBy` | number | Epic author. List: `GET \u002Fv1\u002Fusers` |\n| `data.modifiedBy` | number | Who edited the epic last. `0` if it was never edited. List: `GET \u002Fv1\u002Fusers` |\n| `data.color` | string | Epic color in HEX format |\n| `data.files` | array | Epic attachment file IDs, e.g. `[417]` |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 7,\n    \"groupId\": 45,\n    \"name\": \"Reports\",\n    \"description\": \"Summary reports by sprint\",\n    \"createdBy\": 1,\n    \"modifiedBy\": 1,\n    \"color\": \"#69dafc\",\n    \"files\": [417]\n  }\n}\n```\n\nFor an epic with no attachments, `files` is an empty array `[]`.\n\n## Error response example\n\n404 — not found:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Epic not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer |\n| 404 | `ENTITY_NOT_FOUND` | No epic exists with the given `id` |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 401 | `TOKEN_MISSING` | The key has no configured tokens |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List epics](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Update an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fupdate)\n- [Scrum epics](\u002Fdocs\u002Fscrum\u002Fepics)\n- [Workgroups](\u002Fdocs\u002Fentities\u002Fworkgroups)\n","## Update an epic\n\n`PATCH \u002Fv1\u002Fscrum\u002Fepics\u002F:id`\n\nPartially updates a scrum-project epic: rename, recolor, change the description or the scrum project. The body is flat, with no `fields` wrapper.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | yes | Epic ID |\n\n## Request fields (body)\n\nPass only the fields you want to change. At least one of the listed fields is required.\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|---------|\n| `name` | string | no | New epic name. Up to 65,535 characters |\n| `groupId` | number | no | New scrum project ID. List: `GET \u002Fv1\u002Fworkgroups` |\n| `description` | string | no | New description. Up to 65,535 characters |\n| `color` | string | no | New epic color, for example `\"#5eead4\"`. Up to 64 characters |\n| `modifiedBy` | number | no | ID of the user who modified the epic. List: `GET \u002Fv1\u002Fusers` |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.com\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 application\n\n```bash\ncurl -X PATCH https:\u002F\u002Fvibecode.bitrix24.com\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 — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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 application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\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## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | object | The epic after the update |\n| `data.id` | number | Epic ID |\n| `data.groupId` | number | Scrum project ID |\n| `data.name` | string | Epic name |\n| `data.description` | string | Epic description |\n| `data.color` | string | Epic color |\n| `data.createdBy` | number | Author ID |\n| `data.modifiedBy` | number | ID of the last editor |\n\n## Response example\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## Error response example\n\n400 — validation failed:\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## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Empty body, non-numeric `id`, wrong field type, or `createdBy` passed |\n| 404 | `ENTITY_NOT_FOUND` | No epic exists with the given `id` |\n| 422 | `BITRIX_ERROR` | Bitrix24 returned an error while updating the epic |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only |\n| 401 | `TOKEN_MISSING` | The key has no configured tokens |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**`createdBy` is set only on creation.** On update this field is rejected with `400 INVALID_PARAMS` and the message \"createdBy can only be set on create\". Authorship cannot be transferred — to record who made the change, use `modifiedBy`.\n\n## See also\n\n- [Create an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fcreate)\n- [Get an epic](\u002Fdocs\u002Fscrum\u002Fepics\u002Fget)\n- [List epics](\u002Fdocs\u002Fscrum\u002Fepics\u002Flist)\n- [Workgroups](\u002Fdocs\u002Fentities\u002Fworkgroups)\n- [Scrum](\u002Fdocs\u002Fscrum)\n",1794739601580]