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

Получить папку

GET /v1/folders/:id

Возвращает одну папку по её идентификатору.

Параметры

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

Примеры

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

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

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

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

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект папки. Все поля — см. Поля папки

GET /v1/folders/:id адресует только папки. Идентификатор файла возвращает 404 ENTITY_NOT_FOUND — карточка файла доступна через GET /v1/files/:id.

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

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "name": "Загруженные файлы",
    "code": "FOR_UPLOADED_FILES",
    "storageId": 1,
    "type": "folder",
    "realObjectId": 27,
    "parentId": 1,
    "deletedType": 0,
    "createdAt": "2020-04-21T16:09:38.000Z",
    "updatedAt": "2026-06-09T12:29:04.000Z",
    "deletedAt": null,
    "createdBy": 1,
    "updatedBy": 1,
    "deletedBy": null,
    "detailUrl": "https://<portal>.bitrix24.ru/company/personal/user/1/disk/path/Загруженные файлы"
  }
}

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

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "name": "Загруженные файлы",
    "storageId": 1,
    "type": "folder",
    "parentId": 1,
    "_included": {
      "storage": {
        "id": 1,
        "name": "Летта",
        "code": null,
        "module": "disk",
        "entityType": "user",
        "entityId": "1",
        "rootFolderId": 1
      }
    }
  }
}

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

404 — папка не найдена:

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

Ошибки

HTTP Код Описание
400 INVALID_INCLUDE Значение include не поддерживается. Доступное значение — storage
404 ENTITY_NOT_FOUND Папки с указанным id нет, либо id принадлежит файлу
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING API-ключ не имеет настроенных токенов портала

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

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