curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/users/lookup?by=discord_id&value=123456789012345678'
{
"members": []
}
Состав
Найти сотрудника по ID или никнейму
Поиск по Discord ID, Telegram ID, ID или ссылке профиля форума, внутреннему UUID пользователя или записи состава, либо никнейму CRM.
GET
/
api
/
partner
/
v1
/
servers
/
{server_id}
/
users
/
lookup
curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/users/lookup?by=discord_id&value=123456789012345678'
{
"members": []
}
Поиск по Discord ID, Telegram ID, ID или ссылке профиля форума, внутреннему UUID пользователя или записи состава, либо никнейму CRM. Требуется право roster:read и доступ к выбранному серверу. Возвращает только текущий состав (active/inactive), включая незарегистрированных сотрудников. При нескольких совпадениях возвращает страницу members. Для продолжения повторите by и value и передайте next_cursor как cursor. Пустой members означает отсутствие совпадений в доступном составе.
См. формат ошибок и правила повторов.
Доступ
roster:read.
Партнёрский Bearer-токен. Подробнее в разделе «Авторизация».
Параметры
Уникальный номер сервера из GET /api/partner/v1/servers или UUID сервера. Сервер должен входить в выданный боту доступ.
Тип поиска: 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.Значение выбранного идентификатора строкой. Для nickname — часть имени в составе CRM (от 2 до 100 символов, без учёта регистра). Для forum_url — ссылка на профиль настроенного форума. Forum_id — числовой ID на этом форуме. Для internal_id — UUID пользователя или записи состава. До 2048 символов.
Успешный ответ
HTTP200. Запрос выполнен успешно.
Сотрудники текущей страницы состава.
Курсор следующей страницы. Пустое значение или отсутствие поля означает, что следующей страницы нет.
Ошибки
| HTTP | Значение |
|---|---|
400 | Некорректные параметры запроса. |
401 | Токен отсутствует, недействителен, отозван или не разрешён для этого IP-адреса. |
403 | Недостаточно прав у бота или указанного модератора; сервер или функция не входят в выданный доступ. |
422 | Данные не прошли проверку формата или ограничений. Подробности находятся в поле errors. |
429 | Превышен лимит запросов. Дождитесь интервала, указанного в заголовке Retry-After. |
500 | Внутренняя ошибка сервера. |
503 | Сервис временно недоступен. Повторите запрос позднее. |
Пример
В примере использованы условные идентификаторы.curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/users/lookup?by=discord_id&value=123456789012345678'
{
"members": []
}