Пошук користувачів за ім'ям

GET/v1/search/1₽ за 2xx

Повертає список користувачів, що збігаються за ім’ям. Відповідь містить тільки базові поля користувачів (id, username, name, is_bot, is_deleted). Повний профіль — через GET /v1/users/{identifier}.

Авторизація

Потрібен заголовок Api-Key.

Query-параметри

Ім’я	Тип	Обов’язковий	За замовчуванням	Опис
name	string	так	—	Непорожнє ім’я або пошукова фраза.
raw	boolean	ні	false	Якщо true, повертати тільки точні збіги.

Приклади

cURL

# Повнотекстовий пошук
curl -G -H "Api-Key: $API_KEY" \
  --data-urlencode "name=john" \
  https://api.telesint.dev/v1/search/

# Точний збіг
curl -G -H "Api-Key: $API_KEY" \
  --data-urlencode "name=John Doe" \
  --data-urlencode "raw=true" \
  https://api.telesint.dev/v1/search/

Python

import os, requests

def search_users(name: str, raw: bool = False) -> list[dict]:
    response = requests.get(
        "https://api.telesint.dev/v1/search/",
        headers={"Api-Key": os.environ["API_KEY"]},
        params={"name": name, "raw": raw},
        timeout=10,
    )
    response.raise_for_status()
    return response.json()["data"]

matches = search_users("john")

JavaScript

async function searchUsers(name, { raw = false } = {}) {
  const params = new URLSearchParams({ name, raw: String(raw) });
  const res = await fetch(
    `https://api.telesint.dev/v1/search/?${params}`,
    { headers: { 'Api-Key': process.env.API_KEY } },
  );
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  const { data } = await res.json();
  return data;
}

const users = await searchUsers('john');

Відповідь — 200 OK

{
  "data": [
    {
      "id": 12345,
      "username": "johndoe",
      "name": "John Doe",
      "is_bot": false,
      "is_deleted": false
    },
    {
      "id": 67890,
      "username": null,
      "name": "John",
      "is_bot": false,
      "is_deleted": false
    }
  ]
}

Поля — data[]

Поле	Тип	Опис
id	integer	ID користувача.
username	string | null	Username, якщо є.
name	string	Ім’я для відображення.
is_bot	boolean | null	true для ботів.
is_deleted	boolean | null	true для видалених акаунтів.

Повнотекстовий і точний пошук

• Повнотекстовий (за замовчуванням, raw=false) — повертає до 50 результатів, упорядкованих за релевантністю.
• Точний (raw=true) — поле name має збігатися із запитом точно.

Помилки

• 422 — параметр name відсутній або порожній.
• Див. Помилки.