## Список содержимого папки

`GET /v1/folders`

Возвращает содержимое папки — вложенные подпапки и файлы. Параметр `parentId` обязателен — без него запрос возвращается с `400`.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|----------|-----|:-----:|-----------|----------|
| `parentId` (query) | number | да | | ID папки, чьё содержимое перечисляется. Корневая папка хранилища — поле `rootFolderId` в `GET /v1/storages` |
| `filter` (query) | object | нет | | Фильтрация только по полям, которые умеет фильтровать Битрикс24: `id`, `name`, `code`, `storageId`, `type`, `parentId`, `deletedType`, `createdAt`, `updatedAt`, `deletedAt`. Остальные поля из `GET /v1/folders/fields` (например `createdBy`, `updatedBy`) фильтровать нельзя — такой запрос вернёт `400 UNSUPPORTED_FILTER` со списком допустимых. Операторы (`$gt`, `$contains` и прочие) не поддерживаются: только точное совпадение и `$in`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[type]=folder` |
| `select` (query) | string | нет | все поля | Список возвращаемых полей через запятую. Пример: `?select=id,name` |
| `order` (query) | object | нет | | Сортировка по полю. Пример: `?order[name]=asc` |
| `limit` (query) | number | нет | 50 | Сколько записей вернуть. Максимум 5000 |
| `offset` (query) | number | нет | 0 | Смещение для постраничной выборки |
| `include` (query) | string | нет | | Подгрузить связанный объект к каждой записи. Доступное значение — `storage`. Результат приходит в блоке `_included`. Для выборки более 200 записей связи не подгружаются, в `meta.includeSkipped` придёт `true` |

Для `limit > 50` Вайбкод автоматически пагинирует запрос на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше, в `meta.hasMore` придёт `true`.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/folders?parentId=27&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/folders?parentId=27&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const params = new URLSearchParams({ parentId: '27', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/folders?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log('Записей:', data.length, 'всего:', meta.total)
```

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

```javascript
const params = new URLSearchParams({ parentId: '27', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/folders?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив записей — подпапки (`type: "folder"`) и файлы (`type: "file"`). Все поля — см. [Поля папки](./fields.md) |
| `data[].type` | string | Тип записи: `"folder"` или `"file"`. Различает две схемы строк в одном массиве |
| `meta.total` | number | Общее количество записей в папке |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

Записи-файлы несут собственный набор полей — `fileId`, `size`, `globalContentVersion`, `downloadUrl`, `folderId` — и не содержат `realObjectId`. Управление файлами — в разделе [Файлы](/docs/entities/files).

Поле `detailUrl` — полный URL карточки папки в Битрикс24, например `https://<portal>.bitrix24.ru/company/personal/user/1/disk/path/<имя>/`. `<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 9301,
      "name": "Документы",
      "code": null,
      "storageId": 1,
      "type": "folder",
      "realObjectId": 9301,
      "parentId": 27,
      "deletedType": 0,
      "createdAt": "2026-06-25T12:10:00.000Z",
      "updatedAt": "2026-06-25T12:10:00.000Z",
      "deletedAt": null,
      "createdBy": 1,
      "updatedBy": 1,
      "deletedBy": null,
      "detailUrl": "https://<portal>.bitrix24.ru/company/personal/user/1/disk/path/Документы"
    },
    {
      "id": 205,
      "name": "отчёт.pdf",
      "code": null,
      "storageId": 1,
      "type": "file",
      "folderId": 27,
      "deletedType": 0,
      "globalContentVersion": 1,
      "fileId": 363,
      "size": 31232,
      "createdAt": "2020-05-15T09:29:09.000Z",
      "updatedAt": "2020-05-15T09:29:09.000Z",
      "deletedAt": null,
      "createdBy": 1,
      "updatedBy": 1,
      "deletedBy": null,
      "downloadUrl": "https://<portal>.bitrix24.ru/rest/1/****/download/?token=****"
    }
  ],
  "meta": { "total": 22, "hasMore": false }
}
```

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

```json
{
  "success": true,
  "data": [
    {
      "id": 9301,
      "name": "Документы",
      "storageId": 1,
      "type": "folder",
      "parentId": 27,
      "_included": {
        "storage": {
          "id": 1,
          "name": "Летта",
          "code": null,
          "module": "disk",
          "entityType": "user",
          "entityId": "1",
          "rootFolderId": 1
        }
      }
    }
  ],
  "meta": { "total": 22, "hasMore": false }
}
```

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

400 — не передан обязательный `parentId`:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_PARAMS",
    "message": "GET /v1/folders requires query parameters: parentId. Example: GET /v1/folders?parentId=..."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_PARAMS` | Не передан обязательный `parentId` |
| 400 | `INVALID_INCLUDE` | Значение `include` не поддерживается. Доступное значение — `storage` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `disk` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов портала |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

`GET /v1/folders` перечисляет детей одной папки, заданной через `parentId`. Это не плоский список всех папок хранилища — для обхода дерева запрашивайте каждую папку отдельно по её `id`. Корневую папку хранилища даёт поле `rootFolderId` в `GET /v1/storages`.

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

- [Получить папку](/docs/entities/folders/get)
- [Создать папку](/docs/entities/folders/create)
- [Поля папки](/docs/entities/folders/fields)
- [Файлы](/docs/entities/files)
- [Хранилища](/docs/entities/storages)
- [Синтаксис фильтрации](/docs/filtering)