Skip to main content
GET
Поиск по Discord ID, Telegram ID, ID или ссылке профиля форума, внутреннему UUID пользователя или записи состава, либо никнейму CRM. Требуется право roster:read и доступ к выбранному серверу. Возвращает только текущий состав (active/inactive), включая незарегистрированных сотрудников. При нескольких совпадениях возвращает страницу members. Для продолжения повторите by и value и передайте next_cursor как cursor. Пустой members означает отсутствие совпадений в доступном составе.

Доступ

roster:read.
string
required
Партнёрский Bearer-токен. Подробнее в разделе «Авторизация».

Параметры

union
required
Уникальный номер сервера из GET /api/partner/v1/servers или UUID сервера. Сервер должен входить в выданный боту доступ.
string
required
Тип поиска: discord_id — ID Discord. Telegram_id — ID Telegram. Forum_id — числовой ID форума. Forum_url — ссылка на профиль форума. Internal_id — UUID пользователя или записи состава. Nickname — имя сотрудника в CRM. Допустимые значения discord_id, telegram_id, forum_id, forum_url, internal_id, nickname.
string
required
Значение выбранного идентификатора строкой. Для nickname — часть имени в составе CRM (от 2 до 100 символов, без учёта регистра). Для forum_url — ссылка на профиль настроенного форума. Forum_id — числовой ID на этом форуме. Для internal_id — UUID пользователя или записи состава. До 2048 символов.
integer
Максимальное число записей в одной странице. По умолчанию 25. Диапазон от 1 до 100.
string
Курсор из next_cursor предыдущей страницы. В первом запросе не передавайте. До 36 символов.

Успешный ответ

HTTP 200. Запрос выполнен успешно.
object[] | null
required
Сотрудники текущей страницы состава.
string
Курсор следующей страницы. Пустое значение или отсутствие поля означает, что следующей страницы нет.

Ошибки

См. формат ошибок и правила повторов.

Пример

В примере использованы условные идентификаторы.