Для AI-агентов: markdown этой страницы — /docs-content/entities/files/get.md индекс документации — /llms.txt

Получить файл

GET /v1/files/:id

Возвращает файл по ID со всеми полями, включая ссылку для скачивания и прямой URL в интерфейсе Битрикс24.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID файла. Получить: GET /v1/files?folderId=X
Параметрinclude (query) Типstring Обяз.нет ОписаниеПодгрузить связанный объект. Доступное значение — folder. Результат приходит в блоке _included

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/files/205" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/files/205" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/files/205', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Файл:', data.name, '—', data.size, 'байт')

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

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

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

Поля ответа

Поле Тип Только чтение Описание
Полеsuccess Типboolean Только чтение ОписаниеВсегда true при успехе
Полеdata.id Типnumber Только чтение✓ ОписаниеИдентификатор файла
Полеdata.name Типstring Только чтение ОписаниеИмя файла
Полеdata.code Типstring|null Только чтение ОписаниеСимвольный код файла
Полеdata.storageId Типnumber Только чтение✓ ОписаниеID хранилища. Список: GET /v1/storages
Полеdata.type Типstring Только чтение✓ ОписаниеТип объекта: всегда "file"
Полеdata.folderId Типnumber Только чтение ОписаниеID родительской папки. Список: GET /v1/folders
Полеdata.deletedType Типnumber Только чтение✓ ОписаниеСтатус удаления: 0 — активен, 3 — в корзине, 4 — удалён вместе с папкой
Полеdata.globalContentVersion Типnumber Только чтение✓ ОписаниеСчётчик версий файла
Полеdata.fileId Типnumber Только чтение✓ ОписаниеВнутренний идентификатор файла в Битрикс24
Полеdata.size Типnumber Только чтение✓ ОписаниеРазмер файла в байтах
Полеdata.createdBy Типnumber Только чтение✓ ОписаниеID пользователя-создателя. Список: GET /v1/users
Полеdata.updatedBy Типnumber Только чтение✓ ОписаниеID автора последнего изменения. Список: GET /v1/users
Полеdata.deletedBy Типnumber|null Только чтение✓ ОписаниеID пользователя, удалившего файл; null — файл не удалён
Полеdata.createdAt Типdatetime Только чтение✓ ОписаниеДата и время создания (ISO 8601)
Полеdata.updatedAt Типdatetime Только чтение✓ ОписаниеДата и время последнего изменения (ISO 8601)
Полеdata.deletedAt Типdatetime|null Только чтение✓ ОписаниеДата и время перемещения в корзину; null — файл не удалён
Полеdata.downloadUrl Типstring Только чтение✓ ОписаниеАдрес скачивания файла через API Вайбкод, GET /v1/files/:id/download. Запрос по нему передаёт заголовок X-Api-Key
Полеdata.detailUrl Типstring Только чтение✓ ОписаниеСсылка на файл в интерфейсе Битрикс24
Полеdata.contentProvider Типstring Только чтение✓ ОписаниеПоставщик контента (может отсутствовать)

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

JSON 
{
  "success": true,
  "data": {
    "id": 205,
    "name": "project-report.pdf",
    "code": null,
    "storageId": 1,
    "type": "file",
    "folderId": 27,
    "deletedType": 0,
    "globalContentVersion": 1,
    "fileId": 363,
    "size": 31232,
    "createdBy": 1,
    "updatedBy": 1,
    "deletedBy": null,
    "createdAt": "2020-05-15T09:29:09.000Z",
    "updatedAt": "2020-05-15T09:29:09.000Z",
    "deletedAt": null,
    "downloadUrl": "https://vibecode.bitrix24.tech/v1/files/205/download",
    "detailUrl": "https://example.bitrix24.ru/disk/file/project-report.pdf/"
  }
}

С параметром include=folder добавляется блок _included с родительской папкой. Показаны основные поля файла:

JSON 
{
  "success": true,
  "data": {
    "id": 205,
    "name": "project-report.pdf",
    "storageId": 1,
    "type": "file",
    "folderId": 27,
    "_included": {
      "folder": {
        "id": 27,
        "name": "Загруженные файлы",
        "code": "FOR_UPLOADED_FILES",
        "storageId": 1,
        "type": "folder",
        "parentId": 1,
        "createdBy": 1,
        "updatedBy": 1,
        "deletedBy": null
      }
    }
  }
}

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

404 — файл не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Could not find entity with id '99999999'."
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеФайл с указанным ID не существует
HTTP400 КодINVALID_INCLUDE ОписаниеЗначение include не поддерживается. Доступное значение — folder
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа disk
HTTP401 КодTOKEN_MISSING ОписаниеКлюч не имеет настроенных токенов авторизации
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан: такой строки на платформе нет

Полный список общих ошибок API — Ошибки.

Известные особенности

downloadUrl ведёт на GET /v1/files/:id/download: адрес постоянный и не содержит токена авторизации. Как и любой вызов API, запрос по нему требует заголовок X-Api-Key ключа со скоупом disk или crm.

Метод возвращает только объекты типа "file". Чтобы получить данные папки, используйте GET /v1/folders/:id.

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