[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdocuments\u002Fcrm-list":3,"docs-tabs-entities\u002Fdocuments\u002Fcrm-list":6},{"content":4,"lastmod":5},"## Документы по CRM-сущности\n\n`GET \u002Fv1\u002Fcrm-documents`\n\nВозвращает документы, прикреплённые к конкретной записи CRM — сделке, контакту, компании, лиду, предложению, счёту или элементу смарт-процесса. В отличие от списка всех документов портала, отбор идёт по типу записи и её идентификатору.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | По умолч. | Описание |\n|----------|-----|-------|-----------|---------|\n| `entityTypeId` (query) | number | да | — | Тип записи CRM. Допустимые значения — в списке «Типы записей CRM» ниже |\n| `entityId` (query) | number | нет | — | ID записи. Без него возвращаются документы всех записей указанного типа. Где взять ID по типу — в списке «Типы записей CRM» ниже |\n| `select` (query) | string | нет | — | Выборка полей: `?select=id,title,number` |\n| `order` (query) | object | нет | — | Сортировка: `?order[updateTime]=desc`. Направление — `asc` или `desc` |\n| `start` (query) | number | нет | `0` | Смещение для постраничного чтения |\n\nЗа один вызов возвращается до 50 документов. Для следующей страницы передайте значение `meta.next` в параметр `start`. Когда документов больше нет, `meta.next` равно `null`.\n\n### Типы записей CRM\n\nЗначение `entityTypeId` и эндпоинт, откуда взять `entityId`:\n\n- `1` — лид. ID записи: `GET \u002Fv1\u002Fleads`\n- `2` — сделка. ID записи: `GET \u002Fv1\u002Fdeals`\n- `3` — контакт. ID записи: `GET \u002Fv1\u002Fcontacts`\n- `4` — компания. ID записи: `GET \u002Fv1\u002Fcompanies`\n- `7` — предложение. ID записи: `GET \u002Fv1\u002Fquotes`\n- `31` — счёт. ID записи: `GET \u002Fv1\u002Finvoices`\n- `128` и выше — элемент смарт-процесса. Значение `entityTypeId` — из `GET \u002Fv1\u002Fsmart-processes`, ID записи — из `GET \u002Fv1\u002Fitems\u002F:entityTypeId`\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcrm-documents?entityTypeId=2&entityId=15&order[updateTime]=desc\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcrm-documents?entityTypeId=2&entityId=15&order[updateTime]=desc\" \\\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\u002Fcrm-documents?entityTypeId=2&entityId=15&order[updateTime]=desc', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data, meta } = await res.json()\nconsole.log(`У записи ${meta.total} документов`)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcrm-documents?entityTypeId=2&entityId=15&order[updateTime]=desc', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data, meta } = await res.json()\n```\n\n## Поля ответа\n\nИдентификаторы возвращаются строками.\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | array | Массив документов |\n| `data[].id` | string | Идентификатор документа |\n| `data[].title` | string | Название документа |\n| `data[].number` | string | Номер документа |\n| `data[].templateId` | string | Идентификатор шаблона. Источник — `GET \u002Fv1\u002Fdoc-templates` |\n| `data[].entityTypeId` | string | Тип записи CRM, к которой прикреплён документ |\n| `data[].entityId` | string | ID записи CRM, к которой прикреплён документ |\n| `data[].fileId` | string | Идентификатор готового файла |\n| `data[].pdfId` | string | Идентификатор PDF-версии |\n| `data[].imageId` | string | Идентификатор изображения-превью |\n| `data[].downloadUrl` | string | Ссылка на скачивание файла для пользователя |\n| `data[].pdfUrl` | string | Ссылка на PDF для пользователя |\n| `data[].imageUrl` | string | Ссылка на изображение-превью для пользователя |\n| `data[].downloadUrlMachine` | string | Ссылка на скачивание для приложения |\n| `data[].pdfUrlMachine` | string | Ссылка на PDF для приложения |\n| `data[].imageUrlMachine` | string | Ссылка на изображение для приложения |\n| `data[].stampsEnabled` | boolean | Включены ли подпись и печать |\n| `data[].values` | object | Значения полей-меток шаблона |\n| `data[].createTime` | string | Дата создания в формате ISO 8601 |\n| `data[].updateTime` | string | Дата изменения в формате ISO 8601 |\n| `data[].createdBy` | string | ID создателя. Источник — `GET \u002Fv1\u002Fusers` |\n| `data[].updatedBy` | string \\| null | ID последнего редактора. Источник — `GET \u002Fv1\u002Fusers` |\n| `meta.total` | number | Количество документов у записи |\n| `meta.start` | number | Смещение текущей страницы |\n| `meta.next` | number \\| null | Смещение следующей страницы. `null`, если документов больше нет |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": \"405\",\n      \"title\": \"Счёт А161\",\n      \"number\": \"А161\",\n      \"templateId\": \"1\",\n      \"entityTypeId\": \"2\",\n      \"entityId\": \"15\",\n      \"fileId\": \"1369\",\n      \"pdfId\": \"1373\",\n      \"imageId\": \"1371\",\n      \"downloadUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.download&id=405\",\n      \"pdfUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.getPdf&id=405\",\n      \"imageUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.getImage&id=405\",\n      \"downloadUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.download\u002F?id=405\",\n      \"pdfUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.getPdf\u002F?id=405\",\n      \"imageUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.getImage\u002F?id=405\",\n      \"stampsEnabled\": false,\n      \"values\": { \"_creationMethod\": \"public\" },\n      \"createTime\": \"2026-01-18T11:10:00+03:00\",\n      \"updateTime\": \"2026-01-18T11:10:00+03:00\",\n      \"createdBy\": \"29\",\n      \"updatedBy\": null\n    },\n    {\n      \"id\": \"406\",\n      \"title\": \"Акт А162\",\n      \"number\": \"А162\",\n      \"templateId\": \"4\",\n      \"entityTypeId\": \"2\",\n      \"entityId\": \"15\",\n      \"fileId\": \"1402\",\n      \"pdfId\": \"1404\",\n      \"imageId\": \"1403\",\n      \"downloadUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.download&id=406\",\n      \"pdfUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.getPdf&id=406\",\n      \"imageUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=crm.documentgenerator.document.getImage&id=406\",\n      \"downloadUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.download\u002F?id=406\",\n      \"pdfUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.getPdf\u002F?id=406\",\n      \"imageUrlMachine\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Frest\u002F1\u002FAPP_TOKEN\u002Fcrm.documentgenerator.document.getImage\u002F?id=406\",\n      \"stampsEnabled\": false,\n      \"values\": { \"_creationMethod\": \"public\" },\n      \"createTime\": \"2026-01-19T09:30:00+03:00\",\n      \"updateTime\": \"2026-01-19T09:30:00+03:00\",\n      \"createdBy\": \"29\",\n      \"updatedBy\": null\n    }\n  ],\n  \"meta\": { \"total\": 2, \"start\": 0, \"next\": null }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — `entityTypeId` не передан или некорректен. Значение `0`, дробное или нечисловое возвращает тот же код:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"MISSING_PARAMS\",\n    \"message\": \"Query parameter `entityTypeId` (positive integer) is required. Common values: 1=LEAD, 2=DEAL, 3=CONTACT, 4=COMPANY, 7=QUOTE, 31=INVOICE, 128+ for smart processes.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `MISSING_PARAMS` | Не передан `entityTypeId` или его значение не является положительным целым числом |\n| 400 | `INVALID_ENTITY_ID` | `entityId` передан, но не является положительным целым числом |\n| 400 | `INVALID_START` | `start` передан, но не является целым числом 0 или больше |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `crm` |\n| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |\n| 401 | `TOKEN_MISSING` | Ключу авторизации не сопоставлены токены — ключ OAuth-приложения вызван без пользовательской сессии |\n| 422 | `BITRIX_ERROR` | Модуль генератора документов не установлен на портале |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\nПараметр `select` ограничивает набор полей, но ссылки на файлы `downloadUrl`, `pdfUrl`, `imageUrl` вместе с машинными вариантами, а также `stampsEnabled` и `values` возвращаются всегда, даже если их нет в выборке.\n\n## Смотрите также\n\n- [Список документов](\u002Fdocs\u002Fentities\u002Fdocuments\u002Flist)\n- [Создать документ](\u002Fdocs\u002Fentities\u002Fdocuments\u002Fcreate)\n- [Шаблоны документов](\u002Fdocs\u002Fentities\u002Fdoc-templates)\n","2026-06-19",{}]