Descrição

Retorna uma lista paginada de grupos filtrados por nome. É necessário informar ao menos 2 caracteres no parâmetro de busca. Suporta filtros adicionais por ID e nome da organização. Retorna 12 registros por página por padrão. Os dados são filtrados automaticamente baseado no role do usuário autenticado.

Cabeçalhos

Parâmetros de Consulta

Sucesso - 200

{
  "success": true,
  "message": "Groups filtered successfully.",
  "page": 1,
  "limit": 12,
  "total": 15,
  "data": [
    {
      "group_id": "1",
      "group_name": "Liderança Técnica",
      "org_id": "1",
      "org_name": "OneFactory",
      "created_at": "2025-04-23 10:30:00",
      "updated_at": "2025-04-23 10:30:00",
      "total_members": 8
    },
    {
      "group_id": "2",
      "group_name": "G1 OneFactory",
      "org_id": "1",
      "org_name": "OneFactory",
      "created_at": "2025-04-16 22:08:28",
      "updated_at": "2025-04-16 22:08:28",
      "total_members": 5
    }
  ]
}
    

Erro - 401 (Token inválido)

{
  "status": 401,
  "error": "Token is invalid or has expired"
}
    

Erro - 422 (Nome inválido)

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

Códigos de Resposta

• 200 - Grupos encontrados com sucesso
• 401 - Token inválido ou expirado
• 422 - Parâmetro "group_name" inválido ou ausente

Controle de Acesso por Role

• Admin/Super Admin: Busca em todos os grupos do sistema
• Demais usuários: Buscam apenas em grupos de organizações que criaram

Observações

• É necessário estar autenticado para acessar este endpoint.
• O parâmetro group_name é obrigatório e deve ter no mínimo 2 caracteres.
• A busca é realizada no campo group_name.
• Os dados são filtrados automaticamente baseado no role do usuário.
• A paginação padrão retorna 12 registros por página.
• O campo total_members mostra a quantidade de membros em cada grupo.
• Todos os filtros (group_name, org_id, org_name) podem ser combinados com a paginação.
• Os resultados são ordenados por data de criação (mais recentes primeiro).