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. Suporta paginação e filtros por organização.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/group-user/search/{groupId}?page=1&limit=12&search=John&org_id=&org_name=
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Sim | Busca por nome, sobrenome ou e-mail (mínimo 2 caracteres) |
| page | int | Não | Número da página (padrão: 1) |
| limit | int | Não | Registros por página (padrão: 12) |
| org_id | int | Não | Filtro por ID da organização |
| org_name | string | Não | Busca por nome da organização |
Sucesso - 200
{
"success": true,
"message": "Users filtered successfully.",
"page": 1,
"limit": 12,
"total": 1,
"data": [
{
"user_id": "1",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"avatarUrl": "https://api.soargi.com/public/images/profile/avatar.jpg",
"org_id": "36",
"org_name": "OneFactory",
"group_id": "44",
"group_name": "G1 OneFactory"
}
]
}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