Skip to content

Busca de Usuários ​

Este endpoint permite buscar usuários registrados no sistema com base em um termo de pesquisa, útil para funcionalidades como compartilhamento ou menções.

Objeto Usuário Encontrado ​

AtributoTipoDescrição
idstringO ID único do usuário (UUID).
usernamestringO nome de usuário.
emailstringO endereço de e-mail do usuário.
handlestringO identificador único do usuário (ex: @nome_usuario).
avatar_urlstringA URL para a imagem de avatar do usuário.

Buscar Usuários ​

Retorna uma lista de usuários que correspondem a um termo de pesquisa.

GET/api/users

Parâmetros de Query ​

ParâmetroTipoDescrição
querystringObrigatório. O termo de pesquisa (pode ser parte do nome de usuário, email ou handle).

Resposta ​

Retorna um array de objetos de Usuário Encontrado.

json
[
  {
    "id": "u1v2w3x4-y5z6-7890-1234-567890abcdef",
    "username": "João Silva",
    "email": "joao.silva@example.com",
    "handle": "@joaosilva",
    "avatar_url": "https://example.com/avatars/joao.png"
  }
]

Códigos de Status HTTP ​

  • 200 OK: Usuários encontrados e listados com sucesso.
  • 400 Bad Request: Parâmetro de query query ausente.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao buscar usuários.