Nunciatura Provista

API Documentation V1

Obter Informador

Retorna os dados de um informador específico

Este endpoint é do tipo: Protected

Descrição

Retorna os dados completos de um usuário com role de informador específico.

  • Retorna apenas usuários com role de "informador"
  • Inclui dados do usuário com role aninhada
  • Iniciais geradas automaticamente ignorando artigos e preposições
  • Campos reordenados (created_at e updated_at no final)
  • Requer autenticação JWT válida
  • Retorna erro 404 se usuário não for encontrado ou não for informador

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/informers/{id}

Parâmetros da URL

Campo Tipo Obrigatório Descrição
id string (UUID) Sim ID único do usuário (deve ter role de informador)

Cabeçalhos

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

Exemplo de Requisição

GET /api/informers/uuid-do-informer
Authorization: Bearer <token>
Accept: application/json

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": "uuid-user",
    "first_name": "João",
    "last_name": "da Silva",
    "email": "joao@example.com",
    "email_verified": true,
    "email_verified_at": "2025-10-29T09:15:30.000000Z",
    "role": {
      "id": 2,
      "name": "Informador",
      "slug": "informador",
      "description": "Usuário informador com acesso limitado aos questionários"
    },
    "cpf": "12345678901",
    "phone": "(11) 99999-9999",
    "category": {
      "id": 5,
      "name": "Consultor diocesano",
      "description": "Descrição",
      "active": true
    },
    "treatment_pronoun": {
      "id": 1,
      "name": "Pe.",
      "description": "Padre",
      "active": true
    },
    "diocese": {
      "id": 10,
      "name": "Diocese Y",
      "state": "SP",
      "active": true
    },
    "process": {
      "id": "uuid-processo",
      "name": "Provisão Diocese X",
      "protocol": "PROV-2025-001"
    },
    "group": {
      "id": "uuid-grupo",
      "name": "Grupo 1",
      "color": "#845ADF",
      "description": "Descrição do grupo"
    },
    "created_at": "2025-10-27T10:00:00.000000Z",
    "updated_at": "2025-10-29T10:00:00.000000Z"
  }
}

Nota: A resposta inclui os campos email_verified (booleano) e email_verified_at (data) para indicar verificação de email, além do campo blacklisted.

Erro - 404 (Informador não encontrado)

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

Condição: ID fornecido não corresponde a nenhum informador

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token inválido"
}

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

Códigos de Resposta

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