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

GET /v1/files/:id

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

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID файла. Получить: GET /v1/files?folderId=X

#Примеры

#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.realObjectId number ✓ Внутренний ID объекта
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 ✓ Ссылка для скачивания файла
data.detailUrl string ✓ Ссылка на файл в интерфейсе Битрикс24
data.contentProvider string ✓ Поставщик контента (может отсутствовать)

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

JSON 
{
  "success": true,
  "data": {
    "id": 205,
    "name": "project-report.pdf",
    "code": null,
    "realObjectId": 205,
    "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://example.bitrix24.ru/disk/downloadFile/363/?...",
    "detailUrl": "https://example.bitrix24.ru/disk/file/project-report.pdf/"
  }
}

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

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

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

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Файл с указанным ID не существует
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING Ключ не имеет настроенных токенов авторизации
401 INVALID_API_KEY Неверный или просроченный API-ключ

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

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

downloadUrl содержит токен авторизации и действует ограниченное время. Для программного скачивания используйте GET /v1/files/:id/download — он возвращает перенаправление на актуальную ссылку без встроенного токена.

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

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