Боты, которых вызывающий вправе настраивать: созданные им самим и те, чьи настройки открывают ему доступ к редактированию. Если создавать интеграции разрешено только администраторам, сотруднику без этой роли метод отвечает 403, даже для его собственных ботов.
Параметр query отбирает ботов по части имени или ника, без опечаток. Токены ботов в списке не приходят: значение токена показывают один раз, а сами токены бота отдаёт GETСписок токенов бота.
Перечень всех ботов пространства, включая чужих, доступен владельцу пространства на тарифе «Корпорация» — GETСписок ботов пространства. Там чужие боты приходят с одними лишь именем и ником, остальные настройки скрыты.
Параметры строки запроса
query
string
Поисковая фраза для фильтрации ботов по имени или нику
Пример:
задачlimit
integer, (int32)
Количество возвращаемых сущностей за один запрос. Целое число вне допустимых значений заменяется ближайшей границей.
Пример:
1По умолчанию:
50Диапазон:
1 — 50cursor
string
Курсор для пагинации (из
meta.paginate.next_page)Пример:
eyJpZCI6MTczODgxNn0Ответ
200OK
The request has succeeded.
data[]
array of objects
*id
integer, (int32)
*Идентификатор бота (совпадает с
user_id бота)Пример:
1738816name
string
*Имя бота
Пример:
Бот задачnickname
string
*Никнейм бота
Пример:
tasks_botavatar_url
nullablestring
*Ссылка на аватар бота.
null, если аватар не задан.Пример:
https://files.example.com/uploads/0001/0001/image.jpgcreator_id
nullableinteger, (int32)
*Идентификатор сотрудника, создавшего бота.
null, если создатель не записан.Пример:
12created_at
string, (date-time)
*Дата и время создания бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:
2025-05-15T14:30:00.000Zauthorized_users_count
integer, (int32)
*Сколько сотрудников авторизовали бота
Пример:
3last_used_at
nullablestring, (date-time)
*Дата и время, когда бот последний раз работал (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ: запрос на входящий вебхук или вызов API любым токеном бота, включая токены сотрудников.
null, если такого не было. Использование токена учитывается не чаще раза в минуту.Пример:
2025-05-15T14:30:00.000Zwebhook
object
*Объект параметров вебхука
name
string
*Имя бота
Пример:
Бот задачДлина:
<= 255 символовnickname
string
*Никнейм бота
Пример:
tasks_botДлина:
<= 255 символовoutgoing_url
nullablestring
*URL исходящего вебхука.
null или пустая строка, если адрес не задан: бот тогда получает события только из истории событий, если она включена.Пример:
https://example.com/tasks/newevents[]
array of strings
*События, на которые подписан бот
Возможные значения
Пример:
["message_new"]trigger_on
string
*Условие срабатывания исходящего вебхука
Возможные значения
Пример:
commandscommands[]
array of strings
*Команды бота (триггер-слова)
Пример:
["/task"]scopes[]
array of strings
*Скоупы (права доступа) токена бота. Набор по умолчанию шире того, что можно назначить явно, поэтому здесь могут встречаться значения, недоступные для явной установки.
Пример:
["messages:create"]template
nullablestring
*Шаблон форматирования входящего вебхука.
null, если не задан.Пример:
Заказ от {{ client }} на сумму {{ amount }} ₽template_engine
string
*Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:
liquidchallenge_key
nullablestring
*Название поля проверки для верификации входящего вебхука.
null, если не задано.Пример:
challengelink_preview_enabled
boolean
*Показывать превью ссылок в сообщениях входящего вебхука. При
true ссылки из любых сообщений этого бота, в том числе отправленных через API, получают и боты с разворачиванием ссылок.Пример:
trueignore_self_messages
boolean
*Не присылать боту события о сообщениях, которые он отправил сам, и о реакциях на эти сообщения, кто бы их ни поставил или снял. Нажатия кнопок приходят всегда.
Пример:
falseevents_history_enabled
boolean
*Сохранять историю событий бота для последующего получения через метод истории событий
Пример:
falsesingle_chat
boolean
*Ограничивает бота одной беседой или каналом:
true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.Пример:
falsecan_edit[]
array of strings
*Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:
["admin"]who_can_add
string
*Кто может добавлять бота в чаты
Возможные значения
Пример:
creatorkind
nullablestring
*Источник входящего вебхука.
null, если входящий вебхук у бота выключен.Возможные значения
Пример:
simpleunfurl_domains[]
array of strings
*Домены, ссылки на которые бот разворачивает
Пример:
["example.com"]last_request_at
nullablestring, (date-time)
*Дата и время последнего запроса на входящий вебхук бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ.
null, если запросов не было.Пример:
2025-05-15T14:30:00.000Zurl
nullablestring
Адрес входящего вебхука.
null, если входящий вебхук у бота выключен. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).Пример:
https://api.pachca.com/webhooks/01JAXK7R3B5Y8Q2W4E6T9V1N3Msecret_token
string
Секрет подписи исходящего вебхука: им подписан заголовок
Pachca-Signature. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).Пример:
pachca_wh_3pX9vQ2mL7rT5yW8kN4bH6jF1dS0aZcVxE2uI9oP7qR3tY5wK8nM4gB6hJ1lD0fAlast_request_body
nullablestring
Тело последнего запроса на входящий вебхук бота. Длиннее 128 КБ обрезается и заканчивается на
...[truncated]. null, если запросов не было. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).Пример:
{"client": "ООО Ромашка", "amount": 15000}oauth_client_enabled
boolean
*Включена ли у бота авторизация от имени сотрудника
Пример:
trueoauth_client
nullableobject
*Параметры авторизации от имени сотрудника. Может прийти и у бота с выключенной авторизацией, поэтому включена ли она, смотрите в
oauth_client_enabled. У бота без токенов может прийти null.client_id
string
*Идентификатор клиента для ссылки авторизации
Пример:
aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xYclient_secret_preview
string
*Секрет клиента в маскированном виде. Полное значение приходит в
client_secret один раз: при включении серверного клиента, при переключении клиента на серверный и при ротации секрета.Пример:
cH5kR9mN...x7Qpconfidential
boolean
*Где хранится секрет:
true — серверное приложение, false — приложение без секрета, обмен кода по PKCEПример:
trueredirect_uris[]
array of strings
*Адреса возврата после согласия
Пример:
["https://example.com/oauth/callback"]scopes[]
array of strings
*Права, которые бот запрашивает у сотрудника на экране согласия
Пример:
["messages:read","messages:create"]promo
nullableobject
*Страница бота в витрине.
null, если авторизация у бота выключена.description
nullablestring
*Описание бота.
null, если не задано.Пример:
Собирает сводку по задачам Jira и присылает её в чатpublished
boolean
*Опубликован ли бот в витрине
Пример:
truepromo_images[]
array of objects
*Скриншоты страницы бота
key
string
*Ключ изображения
Пример:
attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.pngurl
string
*Ссылка на изображение
Пример:
https://files.example.com/attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.pngpermissions
object
*Что вы можете делать с этим ботом
update_oauth_client
boolean
*Менять авторизацию от имени сотрудника, страницу в витрине и имя бота
Пример:
truerecreate_token
boolean
*Выпускать, менять и удалять токены бота, менять скоупы основного токена (
webhook.scopes) и обновлять секрет клиентаПример:
truedestroy
boolean
*Удалить бота
Пример:
trueclient_secret
string
Секрет клиента. Приходит один раз: при включении серверного клиента, при переходе на него и при ротации секрета.
Пример:
dGhpc19pc19ub3RfYV9yZWFsX3NlY3JldAmeta
object
*Метаданные пагинации
paginate
object
*Вспомогательная информация
next_page
string
*Курсор пагинации следующей страницы
Пример:
eyJxZCO2MiwiZGlyIjomSNYjIn3prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:
eyJxZCO2MiwiZGlyIjoiYXNjIn0has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице —
false.Пример:
truehas_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора —
false.Пример:
false