## Поиск папок

`POST /v1/folders/search`

Перечисляет содержимое папки через POST-запрос с фильтром в теле. Поведение совпадает с [`GET /v1/folders`](./list.md) — параметры передаются в теле, а не в строке запроса. ID папки передаётся в `filter.parentId` или полем `parentId` на верхнем уровне тела.

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `filter` | object | нет | Условия отбора. `parentId` — ID папки, чьё содержимое перечисляется. Нужен здесь или на верхнем уровне тела.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{"parentId":27,"type":"folder"}` |
| `parentId` | number | нет | ID папки на верхнем уровне тела — вместо `filter.parentId`. Если переданы оба, используется это значение. Только одиночное значение: массив, объект и `null` отклоняются |
| `select` | array | нет | Список возвращаемых полей. Пример: `["id","name"]` |
| `order` | object | нет | Сортировка по полю. Пример: `{"name":"asc"}` |
| `limit` | number | нет | Сколько записей вернуть. По умолчанию 50, максимум 5000 |
| `offset` | number | нет | Смещение для постраничной выборки |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/folders/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"parentId":27,"type":"folder"},"limit":10}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/folders/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"parentId":27,"type":"folder"},"limit":10}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ filter: { parentId: 27, type: 'folder' }, limit: 10 }),
})

const { success, data, meta } = await res.json()
console.log('Найдено:', data.length)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ filter: { parentId: 27, type: 'folder' }, limit: 10 }),
})

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

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

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

Поля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `limit`, последней страницы не исключает.

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

```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/Документы"
    }
  ],
  "meta": { "total": 1, "hasMore": false, "durationMs": 125 }
}
```

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

403 — нет скоупа `disk`:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'disk' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_PARAMS` | ID папки не передан ни в `filter.parentId`, ни в `parentId`. Массив, объект и `null` считаются непереданным значением. Тот же код приходит, если одно из полей — пустая строка, даже когда в другом передан ID. `message` перечисляет недостающие поля |
| 400 | `INVALID_FILTER_OPERATOR` | В одном из полей `parentId` и `filter.parentId` одиночный ID, а в другом — массив, объект или `null`. Запрос отклоняется до обращения к Диску |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `disk` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов портала |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке `x-ratelimit-limit`. Повторите после срока из заголовка `Retry-After` |

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

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

Поиск перечисляет содержимое одной папки, заданной через `parentId`, а не ищет по всему хранилищу. Для разовых выборок проще использовать [`GET /v1/folders`](./list.md) с тем же набором параметров в строке запроса.

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

- [Список содержимого папки](/docs/entities/folders/list)
- [Поля папки](/docs/entities/folders/fields)
- [Папки](/docs/entities/folders)
- [Синтаксис фильтрации](/docs/filtering)