Nunciatura Provista

API Documentation V1

Get User By ID

Retorna os dados completos de um usuário específico pelo seu ID

Este endpoint é do tipo: Protected

Descrição

Retorna os dados básicos de um usuário administrador específico com as seguintes funcionalidades:

  • Busca apenas usuários com role de administrador
  • Carrega apenas o relacionamento role (sem dados do informer)
  • Retorna informações básicas do perfil incluindo img_url e initials
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/users/{id}

Parâmetros da URL

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

Cabeçalhos

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

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": "9fd6b694-602a-461f-a052-c473f59bbcc6",
    "first_name": "João",
    "last_name": "Silva",
    "email": "joao.silva@diocese.com.br",
    "img_url": "https://via.placeholder.com/150/28a745/ffffff?text=JS",
    "initials": "JS",
    "email_verified_at": "2025-01-21T17:00:00.000000Z",
    "created_at": "2025-01-21T17:00:00.000000Z",
    "updated_at": "2025-01-21T17:00:00.000000Z",
    "role": {
      "id": 2,
      "name": "Informador",
      "slug": "informador",
      "description": "Usuário informador com acesso limitado aos questionários"
    }
  }
}

Nota: Este endpoint retorna apenas os dados básicos do usuário e role, sem incluir informações do informer.

Sucesso - 200 (Usuário Admin)

{
  "success": true,
  "data": {
    "id": "b033e2ff-4114-5bgg-9797-e8bfc6c162d0",
    "first_name": "Sergio",
    "last_name": "Borges",
    "email": "sluizborges@gmail.com",
    "img_url": "https://via.placeholder.com/150/28a745/ffffff?text=SB",
    "initials": "SB",
    "email_verified_at": "2025-01-21T17:00:00.000000Z",
    "created_at": "2025-01-21T17:00:00.000000Z",
    "updated_at": "2025-01-21T17:00:00.000000Z",
    "role": {
      "id": 1,
      "name": "Administrador",
      "slug": "admin",
      "description": "Usuário administrador com acesso total ao sistema"
    }
  }
}

Nota: Este endpoint retorna apenas os dados básicos do usuário e role, sem incluir informações do informer.

Erro - 404 (Usuário não encontrado)

{
  "success": false,
  "message": "Usuário não encontrado"
}

Condição: Usuário com o ID especificado não existe

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 Dados do usuário retornados com sucesso
404 Usuário não encontrado
401 Token inválido ou expirado