Detalhar Grupo por ID

Retorna os detalhes de um grupo eclesiástico específico pelo seu UUID

Este endpoint é do tipo: Protected

Descrição

Retorna os detalhes completos de um grupo eclesiástico fixo com as seguintes funcionalidades:

Retorna informações completas do grupo (nome, iniciais G1..G6, descrição, cor)
Inclui métricas: respostas recebidas/esperadas, percentual e status
Retorna últimos 5 informadores com iniciais, blacklist e cor do avatar
Inclui referência ao processo (id, name, protocol)
Nota: Apenas a descrição pode ser editada
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.nabrasil.org.br/v1

ENDPOINT

/groups/{id}

Parâmetros de Rota

Parâmetro	Tipo	Obrigatório	Descrição
id	uuid	Sim	ID único do grupo (UUID)

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": "a022d1ee-3003-4afe-8686-d7aeb5b051c9",
    "initials": "G1",
    "name": "Grupo 1",
    "description": "Bispo em saída/transferido",
    "color": "bg-primary",
    "users_count": 5,
    "answers_received": 12,
    "answers_expected": 15,
    "completion_label": "12/15",
    "completion_percent": 80,
    "status": "Em andamento",
    "recent_informers": [
      {"initials": "JB", "blacklisted": false, "avatar_color": "#26BF94"},
      {"initials": "DC", "blacklisted": false, "avatar_color": "#26BF94"},
      {"initials": "FA", "blacklisted": false, "avatar_color": "#26BF94"},
      {"initials": "RL", "blacklisted": false, "avatar_color": "#26BF94"},
      {"initials": "TM", "blacklisted": true,  "avatar_color": "#000000"}
    ],
    "has_more_users": true,
    "plus_badge_color": "#845ADF",
    "process": {"id": "uuid-processo", "name": "Diocese de São Paulo", "protocol": "PROV-2025-001"}
  }
}

Nota: Este endpoint retorna os detalhes completos do grupo, incluindo os relacionamentos com usuários e questionários associados.

Erro - 404 (Grupo não encontrado)

{
  "success": false,
  "message": "Grupo não encontrado"
}

Condição: O ID fornecido não corresponde a nenhum grupo existente

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT inválido, expirado ou não fornecido

Códigos de Resposta

Código	Descrição
200	Grupo retornado com sucesso
401	Token inválido ou expirado
404	Grupo não encontrado

Nunciatura Provista