Buscar Usuários Por Nome

Descrição

Retorna uma lista com até 10 usuários filtrados por nome (primeiro ou sobrenome). É necessário informar ao menos 2 caracteres no parâmetro de busca.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/users/search?name=Jhon

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Consulta (Query String)

Parâmetro Tipo Obrigatório Descrição
name string Sim Nome ou parte do nome (mínimo 2 caracteres).

Sucesso - 200

{
    "success": true,
    "message": "Users retrieved successfully.",
    "data": [{
        "user_id": 1,
        "first_name": "Jhon",
        "last_name": "Doe",
        "email": "jhon@emai.com",
        "avatarUrl": "https://cdn.meuapp.com/avatar/joana.png",
        "created_at": "2025-04-23 09:45:00"
    }]
}

Erro - 422 (Nome inválido)

{
    "status": 422,
    "error": "Please provide at least 2 characters to search."
}

Erro - 404 (Nenhum usuário encontrado)

{
    "status": 404,
    "error": "No users found with the provided name."
}

Códigos de Resposta

  • 200 - Usuários encontrados
  • 422 - Parâmetro "name" inválido ou ausente
  • 404 - Nenhum usuário encontrado