---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/dev/messenger/doc/ru/api-requests/chat-list.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/messenger/doc/ru/llms.txt

# Получение списка чатов

Метод возвращает список чатов и каналов, в которых бот является участником.

HTTP метод: `GET`

URL: `https://botapi.messenger.yandex.net/bot/v1/chats/get/`

## Заголовки
```
Authorization: OAuth <токен>
```

## Параметры запроса
| Имя параметра | Обязательный | Тип       | Описание                                      | Ограничения, значение по умолчанию                        |
|---------------|--------------|-----------|-----------------------------------------------|-----------------------------------------------------------|
| `limit`       | Нет          | `integer` | Максимальное количество чатов в ответе        | Не более 1000. Значение по умолчанию: `100`               |
| `offset`      | Нет          | `string`  | Смещение для пагинации                        | Значение `id` последнего чата из предыдущего ответа       |

## Результат
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, содержащим список чатов.

| Имя параметра | Обязательный | Тип        | Описание                        |
|---------------|--------------|------------|---------------------------------|
| `ok`          | Да           | `boolean`  | Флаг успешности выполнения      |
| `data`        | Да           | ##[ChatMetaData](../data-types.md#chatmetadata)##`[]` | Список чатов и каналов |

Для получения следующей страницы передайте `id` последнего чата из ответа в параметр `offset`.

В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле `description`.

| Имя параметра | Обязательный | Тип       | Описание                   |
|---------------|--------------|-----------|----------------------------|
| `ok`          | Да           | `boolean` | Флаг успешности выполнения |
| `description` | Да           | `string`  | Описание ошибки            |

## Пример запроса
```
curl -H 'Authorization: OAuth AtXXXXXXXXXXX' 'https://botapi.messenger.yandex.net/bot/v1/chats/get/'
```

## Пример успешного ответа
```json
{
  "ok": true,
  "data": [
    {
      "type": "group",
      "id": "0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9",
      "title": "Рабочий чат",
      "description": "Обсуждение проекта"
    },
    {
      "type": "private",
      "id": "447c35f4-191f-4e98-8711-01885b2dcc18_6d8d04f7-31f7-4030-8926-305587256f0e",
      "username": "vasya@example.org"
    }
  ]
}
```

## Пример ответа с ошибкой
```
{"ok": false, "description": "Unauthorized"}
```