Buscar Usuários Dentro de um Grupo
Descrição
Permite buscar usuários dentro de um grupo, filtrando pelo primeiro nome, sobrenome ou e-mail. É necessário informar pelo menos 2 caracteres.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/group-user/search/{groupId}?name=John
Cabeçalhos
Parâmetro | Valor |
---|---|
Authorization | Bearer Token |
Parâmetros de Consulta
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
name | string | Sim | Nome, sobrenome ou e-mail a ser buscado (mínimo 2 caracteres). |
Sucesso - 200
{
"success": true,
"message": "Users filtered successfully.",
"data": [
{
"user_id": 1,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com"
}
]
}
Erro - 422 (Consulta inválida)
{
"status": 422,
"error": "Please provide at least 2 characters to search."
}
Erro - 404 (Grupo ou usuários não encontrados)
{
"status": 404,
"error": "Group not found."
}
{
"status": 404,
"error": "Group not found."
}
Erro - 500 (Erro Interno)
{
"status": 500,
"error": "Failed to search users."
}
Códigos de Resposta
- 200 - Usuários encontrados com sucesso
- 422 - Termo de busca inválido
- 404 - Grupo ou usuários não encontrados
- 500 - Erro inesperado ao buscar