Поиск пользователей

GET /search/users

Описание

Поиск пользователей по строке запроса (логину). Результаты учитывают настройки видимости пользователей: приватные пользователи видны только им самим и администраторам.

⚠️ Требуется действительный токен авторизации.

Токен

Требуется токен с правами на Чтение для Пользователя.

Заголовки

Параметр	Обязательный	Описание
`accept`	Нет	Тип содержимого ответа. Рекомендуется установить значение `application/vnd.gitverse.object+json;version=latest`

Параметры пути

Данный метод не содержит параметров пути.

Параметры запроса

Параметр	Тип	Обязательный	Описание	По умолчанию
`q`	string	Да	Строка поиска (по логину пользователя)
`sort`	string	Нет	Поле для сортировки результатов (`best_match`, `followers`, `repositories`, `joined`)	`best_match`
`order`	string	Нет	Направление сортировки (`asc`, `desc`)	`desc`
`page`	integer	Нет	Номер страницы результатов (начинается с 1)	`1`
`per_page`	integer	Нет	Количество результатов на странице (максимум 50)	`50`

Тело запроса

Данный метод не требует тела запроса.

Пример запроса

curl -X GET "https://api.gitverse.ru/search/users?q=alice&sort=followers&order=desc&page=1&per_page=10" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=latest"

Ответ (200 OK)

Пример JSON-ответа:

{
  "incomplete_results": false,
  "total_count": 1,
  "items": [
  {
    {
    "id": 66,
    "name": "",
    "login": "login_test",
    "type": "User",
    "bio": "login_test",
    "email": "login_test8@test.ru",
    "avatar_url": "https://api.gitverse.ru/avatars/77e7704bcb51cc76c984a0ebd7f3570e",
    "html_url": "https://api.gitverse.ru/login_test",
    "url": "https://api.gitverse.ru/users/login_test",
    "repos_url": "https://api.gitverse.ru/users/login_test/repos",
    "site_admin": false,
    "location": "login_test",
    "followers": 0,
    "following": 0,
    "public_repos": 1,
    "created_at": "2025-10-16T08:54:47Z",
    "updated_at": "2025-11-14T06:48:45Z"
     }
   }
  ],
}

Коды ответа

Код	Статус	Описание
`200`	OK	Успешный поиск, возвращены результаты
`400`	Bad Request	Некорректный запрос
`401`	Unauthorized	Токен отсутствует или недействителен
`403`	Forbidden	Доступ запрещен
`422`	Unprocessable Entity	Валидация не прошла или эндпоинт заблокирован
`429`	Too Many Requests	Превышен лимит запросов
`500`	Internal Server Error	Внутренняя ошибка сервера
`503`	Service Unavailable	Сервис временно недоступен

Пример тела ошибки

При ответе 400 тело ответа имеет следующий вид:

{
  "error": {
    "code": "BAD_REQUEST",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "The request format is invalid",
    "status": 400
  }
}

Проводник