Listar Todos os Grupos
Descrição
Retorna uma lista paginada de grupos cadastrados no sistema, incluindo informações sobre a organização vinculada e a quantidade de membros em cada grupo. Suporta filtros por nome do grupo, ID da organização 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.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/groups?page=1&limit=12&group_name=&org_id=&org_name=
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | integer | Não | Número da página. Padrão: 1. |
| limit | integer | Não | Quantidade de registros por página. Padrão: 12. |
| group_name | string | Não | Busca por nome do grupo. |
| org_id | integer | Não | Filtrar por ID da organização. |
| org_name | string | Não | Busca por nome da organização. |
Sucesso - 200
{
"success": true,
"message": "Groups retrieved successfully.",
"page": 1,
"limit": 12,
"total": 25,
"data": [
{
"group_id": "1",
"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
},
{
"group_id": "2",
"group_name": "G2 OneFactory",
"org_id": "1",
"org_name": "OneFactory",
"created_at": "2025-04-16 22:10:14",
"updated_at": "2025-04-16 22:10:14",
"total_members": 3
}
]
}
Erro - 401 (Token inválido)
{
"status": 401,
"error": "Token is invalid or has expired"
}
Códigos de Resposta
- 200 - Grupos retornados com sucesso
- 401 - Token inválido ou expirado
Controle de Acesso por Role
- Admin/Super Admin: Ve todos os grupos do sistema
- Demais usuários: Veem apenas grupos de organizações que criaram
Observações
- É necessário estar autenticado para acessar este endpoint.
- Os dados são filtrados automaticamente baseado no role do usuário.
- A paginação padrão retorna 12 registros por página.
- Todos os filtros (group_name, org_id, org_name) podem ser combinados.
- Os grupos são ordenados por data de criação (mais recentes primeiro).
- O campo total_members mostra a quantidade de membros em cada grupo.