Search users by name

GET/v1/search/1₽ per 2xx

Returns a list of users matching the given display name. The response contains only basic user fields (id, username, name, is_bot, is_deleted). For full profiles, call GET /v1/users/{identifier}.

Authentication

Api-Key header required.

Query parameters

Name	Type	Required	Default	Description
name	string	yes	—	Non-empty name or search phrase.
raw	boolean	no	false	If true, only exact matches are returned.

Examples

cURL

# Full-text search
curl -G -H "Api-Key: $API_KEY" \
  --data-urlencode "name=john" \
  https://api.telesint.dev/v1/search/

# Exact match
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');

Response — 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
    }
  ]
}

Fields — data[]

Field	Type	Notes
id	integer	User ID.
username	string | null	Username, if present.
name	string	Display name.
is_bot	boolean | null	true for bots.
is_deleted	boolean | null	true for deleted accounts.

Full-text vs. exact

• Full-text (default, raw=false) — returns up to 50 results ranked by relevance.
• Exact (raw=true) — the name field must equal the query exactly.

Errors

• 422 — missing or empty name.
• See Errors.