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

`GET /v1/chats/folders/:folderId`

Возвращает одну папку текущего пользователя, а для личной папки — ещё её чаты и пользователей личных диалогов из состава.

Чаты системной папки отдаёт [`GET /v1/chats/folders/:folderId/recent`](/docs/chats/discovery/folder-recent).

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `folderId` (path) | number | да | ID папки — поле `id` в [`GET /v1/chats/folders`](/docs/chats/discovery/folders). Положительное целое |

Параметров запроса нет: любой отклоняется с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/folders/127" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/folders/127" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

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

const { success, data } = await res.json()
console.log(data.folder.title, data.chats.length)
```

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

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

const { success, data } = await res.json()
console.log(data.folder.title, data.chats.length)
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.folder` | object | Папка |
| `data.folder.id` | number | ID папки |
| `data.folder.type` | string | `personal` — личная папка, `system` — раздел мессенджера |
| `data.folder.code` | string | Код раздела мессенджера, например `default` или `tasksTask`. Приходит только у системной папки |
| `data.folder.title` | string | Название |
| `data.folder.sort` | number | Порядок папки в интерфейсе |
| `data.folder.visible` | boolean | Папка показывается в интерфейсе |
| `data.folder.description` | string \| null | Описание раздела у системной папки, `null` у личной |
| `data.folder.displaysNestedInRoot` | boolean | Вложенные чаты показываются и в корневом списке |
| `data.folder.definition` | object | У личной папки — состав `{ chats: [{ chatId, dialogId }] }`. У системной — раздел списка: `recentSection` и `parentChatId` |
| `data.chats` | array | Чаты личной папки в формате мессенджера v2: `id`, `dialogId`, `name`, `type`, `role`, `owner`, `permissions` и другие поля. У системной папки — пустой список |
| `data.users` | array | Пользователи личных диалогов из состава папки. Пустой список, если в составе только групповые чаты, а также у системной папки |

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

Личная папка с одним групповым чатом:

```json
{
  "success": true,
  "data": {
    "chats": [
      {
        "avatar": "",
        "color": "#4ba984",
        "description": "",
        "dialogId": "chat5287",
        "diskFolderId": 0,
        "entityData1": "",
        "entityData2": "",
        "entityData3": "",
        "entityId": "",
        "entityType": "",
        "extranet": false,
        "containsCollaber": false,
        "id": 5287,
        "parentChatId": 0,
        "parentMessageId": 0,
        "name": "Docs check",
        "owner": 1,
        "messageType": "C",
        "role": "owner",
        "muteList": [],
        "type": "chat",
        "entityLink": { "type": "", "url": "", "id": "" },
        "permissions": {
          "manageUsersAdd": "member",
          "manageUsersDelete": "manager",
          "manageUi": "member",
          "manageSettings": "owner",
          "manageMessages": "member",
          "manageMessagesAutoDelete": "manager",
          "manageGuestInvites": "manager",
          "manageDelete": "member",
          "canPost": "member"
        },
        "hasManageCapability": false,
        "isNew": false,
        "textFieldEnabled": true,
        "backgroundId": null,
        "canHaveThreads": true
      }
    ],
    "users": [],
    "folder": {
      "id": 127,
      "type": "personal",
      "title": "Ключевые клиенты",
      "sort": 12,
      "visible": true,
      "description": null,
      "displaysNestedInRoot": false,
      "definition": {
        "chats": [{ "chatId": 5287, "dialogId": "chat5287" }]
      }
    }
  }
}
```

Системная папка — списки пустые:

```json
{
  "success": true,
  "data": {
    "chats": [],
    "users": [],
    "folder": {
      "id": 27,
      "type": "system",
      "code": "default",
      "title": "Чаты",
      "sort": 2,
      "visible": true,
      "description": "Все чаты, каналы и проекты",
      "displaysNestedInRoot": false,
      "definition": { "recentSection": "default", "parentChatId": 0 }
    }
  }
}
```

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

422 — папки с таким `folderId` нет:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "FOLDER_NOT_FOUND",
    "b24Code": "FOLDER_NOT_FOUND"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `folderId` не положительное целое или передан параметр запроса. Проверяется до обращения к Битрикс24 |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`: `FOLDER_NOT_FOUND` — папки нет, `FOLDER_ACCESS_DENIED` — папка другого пользователя |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено», код портала — в `error.b24Code` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

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

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

- **Вызов доступен ключу только для чтения.** Аргумент вызова — папка, а не чат, поэтому чтение папки не делает пользователя участником чатов и не считается записью. Список папок [`GET /v1/chats/folders`](/docs/chats/discovery/folders) такому ключу отвечает `403 WRITE_BLOCKED_READONLY_KEY`, поэтому `folderId` для него получайте ключом с правом записи.
- **`FOLDER_NOT_FOUND` приходит в `error.b24Code` ответа `422 BITRIX_ERROR`.** Не путайте его с `404 FOLDER_NOT_FOUND` на странице [Загрузить файл в чат](/docs/chats/files/upload).

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

- [Папки чатов](/docs/chats/discovery/folders)
- [Чаты папки](/docs/chats/discovery/folder-recent)
- [Создать папку чатов](/docs/chats/management/folders-create)
- [Изменить папку чатов](/docs/chats/management/folders-update)
- [Добавить чаты в папку](/docs/chats/management/folder-chats)
- [Убрать чаты из папки](/docs/chats/management/folder-chats-delete)