## Список файлов папки

`GET /v1/files`

Возвращает список объектов в указанной папке: папки и файлы вместе.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|----------|-----|:-----:|-----------|---------|
| `folderId` (query) | number | да | — | ID папки, содержимое которой нужно получить. Список папок: `GET /v1/folders` |
| `limit` (query) | number | нет | `50` | Количество записей (до 5000) |
| `offset` (query) | number | нет | `0` | Пропустить N записей |
| `sort` (query) | string | нет | — | Поле для сортировки |
| `filter` (query) | object | нет | — | Фильтрация по полям `GET /v1/files/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[type]=file` |

**Пагинация.** При `limit > 50` Вайбкод автоматически выполняет несколько запросов к Битрикс24 и возвращает все записи в одном ответе. Максимум — 5000 записей за вызов.

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/files?folderId=27&limit=10" \
  -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?folderId=27&limit=10', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Объектов в папке: ${meta.total}`)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/files?folderId=27&limit=10', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив объектов папки (папки и файлы). Полный список полей элемента — ниже |
| `data[].id` | number | Идентификатор объекта |
| `data[].name` | string | Имя объекта |
| `data[].code` | string\|null | Символьный код; `null`, если не задан |
| `data[].storageId` | number | ID хранилища. Список хранилищ: `GET /v1/storages` |
| `data[].type` | string | Тип: `"file"` или `"folder"` |
| `data[].folderId` | number | ID родительской папки |
| `data[].deletedType` | number | Статус удаления: `0` — активен, `3` — в корзине, `4` — удалён вместе с папкой |
| `data[].realObjectId` | number | Внутренний ID объекта. Присутствует только у папок |
| `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 | Дата удаления (ISO 8601); `null` — не удалён |
| `data[].detailUrl` | string | Ссылка на объект в интерфейсе Битрикс24 |
| `data[].size` | number | Размер файла в байтах. Приходит у записей-файлов |
| `data[].fileId` | number | Внутренний ID файла. Приходит у записей-файлов |
| `data[].globalContentVersion` | number | Счётчик версий файла. Приходит у записей-файлов |
| `data[].downloadUrl` | string | Временная ссылка для скачивания. Приходит у записей-файлов. Для программного скачивания — [`GET /v1/files/:id/download`](./download.md) |
| `data[].contentProvider` | string | Провайдер контента. Возвращается только у файлов из внешних провайдеров контента — у файлов на Диске Битрикс24 не возвращается |
| `meta.total` | number | Общее количество объектов в папке |
| `meta.hasMore` | boolean | Есть ли ещё объекты за пределами `limit` |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1275,
      "name": "Архив проекта",
      "code": "ARCHIVE_PROJECT",
      "storageId": 1,
      "type": "folder",
      "folderId": 27,
      "deletedType": 0,
      "realObjectId": 1275,
      "createdBy": 5,
      "updatedBy": 5,
      "deletedBy": null,
      "createdAt": "2023-04-12T08:30:00.000Z",
      "updatedAt": "2023-04-12T08:30:01.000Z",
      "deletedAt": null,
      "detailUrl": "https://example.bitrix24.ru/docs/path/to/folder/"
    },
    {
      "id": 205,
      "name": "presentation_q1.pdf",
      "code": null,
      "storageId": 1,
      "type": "file",
      "folderId": 27,
      "size": 31232,
      "fileId": 363,
      "globalContentVersion": 1,
      "downloadUrl": "https://example.bitrix24.ru/rest/1/XXXXXX/download/?token=PLACEHOLDER",
      "deletedType": 0,
      "createdBy": 5,
      "updatedBy": 5,
      "deletedBy": null,
      "createdAt": "2023-03-15T09:29:09.000Z",
      "updatedAt": "2023-03-15T09:29:09.000Z",
      "deletedAt": null,
      "detailUrl": "https://example.bitrix24.ru/docs/path/to/file/"
    }
  ],
  "meta": { "total": 40, "hasMore": true }
}
```

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

400 — не передан `folderId`:

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_PARAMS` | Не передан обязательный параметр `folderId` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `disk` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов портала |
| 401 | `INVALID_API_KEY` | Неверный или просроченный API-ключ |

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

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

**Смешанный список.** Ответ содержит одновременно папки (`type: "folder"`) и файлы (`type: "file"`). Разграничить объекты можно по полю `type`. Поля `size`, `fileId`, `globalContentVersion` и `downloadUrl` приходят у записей-файлов. Поле `contentProvider` у файлов на Диске Битрикс24 не возвращается, поле `realObjectId` — только у папок.

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

- [Файлы — обзор](/docs/entities/files)
- [Папки](/docs/entities/folders)
- [Хранилища](/docs/entities/storages)
- [Синтаксис фильтрации](/docs/filtering)
- [Entity API](/docs/entity-api)