Получить группу по ID
GET/v1/groups/{identifier}2₽ за 2xx
Возвращает информацию о группе: заголовок, описание, число участников, языки, администраторов, историю URL.
Авторизация
Заголовок раздела «Авторизация»Требуется заголовок Api-Key.
Параметры пути
Заголовок раздела «Параметры пути»| Имя | Тип | Обязателен | Описание |
|---|---|---|---|
identifier |
string | да | Числовой ID группы или @username (например example_group). |
Примеры
Заголовок раздела «Примеры»# По числовому IDcurl -H "Api-Key: $API_KEY" \ https://api.telesint.dev/v1/groups/12345
# По @usernamecurl -H "Api-Key: $API_KEY" \ https://api.telesint.dev/v1/groups/example_groupimport os, requests
def get_group(identifier: str | int) -> dict: response = requests.get( f"https://api.telesint.dev/v1/groups/{identifier}", headers={"Api-Key": os.environ["API_KEY"]}, timeout=10, ) response.raise_for_status() return response.json()["data"]
group = get_group("example_group")async function getGroup(identifier) { const res = await fetch( `https://api.telesint.dev/v1/groups/${identifier}`, { headers: { 'Api-Key': process.env.API_KEY } }, ); if (!res.ok) throw new Error(`HTTP ${res.status}`); const { data } = await res.json(); return data;}
const group = await getGroup('example_group');Ответ — 200 OK
Заголовок раздела «Ответ — 200 OK»{ "data": { "id": 12345, "url": "example_group", "h_url": [ { "value": "example_group_old", "update": "2021-01-01T00:00:00" }, { "value": "example_group_very_old", "update": "2020-06-01T00:00:00" } ], "title": "Example Group", "about": "Example Group About", "langs": [ { "lang_code": "ru", "name": "Russian" } ], "is_open": true, "users": 100, "admins": [ { "id": 12345, "is_creator": true, "role": "admin", "update": "2021-01-01T00:00:00" } ], "update": "2021-01-01T00:00:00", "create": "2021-01-01T00:00:00", "shadow": false }}Поля — data
Заголовок раздела «Поля — data»| Поле | Тип | Описание |
|---|---|---|
id |
integer | Неизменный ID группы. |
url |
string | null | Текущий @username. |
h_url |
массив history entry | Предыдущие @username. |
title |
string | Заголовок группы. |
about |
string | null | Описание группы. |
langs |
массив { lang_code, name } |
Языки группы. |
is_open |
boolean | true, если список участников доступен в Telegram; false, если скрыт. |
users |
integer | Число участников. |
admins |
массив admin | Администраторы группы. |
update |
string (date-time) | null | Последнее обновление метаданных. |
create |
string (date-time) | null | Когда группа была добавлена в базу. |
shadow |
boolean | null | Указывает, скрыт ли список участников группы; null, если значение неизвестно. |
History entry
Заголовок раздела «History entry»| Поле | Тип | Описание |
|---|---|---|
value |
string | Предыдущее значение @username. |
update |
string (date-time) | null | Когда @username был изменён. |
| Поле | Тип | Описание |
|---|---|---|
id |
integer | ID пользователя-админа. Полный профиль — через GET /v1/users/{identifier}. |
role |
string | null | admin, owner и т.п. |
is_creator |
boolean | null | true для создателя группы. |
update |
string (date-time) | null | Когда запись об админе была подтверждена. |
404— группа не найдена.400— некорректныйidentifier.- См. Ошибки.
Связанные методы
Заголовок раздела «Связанные методы»- Похожие группы.
- Получить пользователя — резолв админов.