Exportar Lista de Informadores em CSV

Gera e baixa um arquivo CSV com a lista de informadores aplicando os mesmos filtros da listagem

Este endpoint é do tipo: Protected

Descrição

Gera e baixa um arquivo CSV com a lista de usuários com role de informador aplicando os mesmos filtros da listagem padrão. O CSV inclui:

Retorna apenas usuários com role de "informador"
Formato CSV padrão com separador de vírgula
Cabeçalho com nomes das colunas em português
Todos os informadores (sem paginação) com dados essenciais: ID, Nome, Sobrenome, Email, CPF, Telefone, Categoria, Pronome de Tratamento, Diocese, Grupo, Processo, Protocolo do Processo, Verificação Email, Iniciais, Role, Data Criação, Data Atualização
Codificação UTF-8 para suporte a caracteres especiais
Suporte aos mesmos filtros da listagem (group_id, diocese_id, category_id, search)
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/informers/export/csv

Parâmetros de Query

Campo	Tipo	Obrigatório	Descrição
group_id	string (UUID)	Não	Filtrar por ID do grupo eclesiástico
diocese_id	integer	Não	Filtrar por ID da diocese
category_id	integer	Não	Filtrar por ID da categoria
search	string	Não	Buscar por nome, sobrenome ou email do informador

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>

Exemplo de Requisição

GET /api/informers/export/csv?group_id=uuid-do-grupo&category_id=5&search=João
Authorization: Bearer <token>

Respostas

Sucesso - 200

Content-Type: text/csv; charset=UTF-8
Content-Disposition: attachment; filename="lista-informadores-2025-01-21.csv"

"ID","Nome","Sobrenome","Email","CPF","Telefone","Categoria","Pronome de Tratamento","Diocese","Grupo","Processo","Protocolo do Processo","Verificação Email","Iniciais","Role","Data Criação","Data Atualização"
"uuid-user","João","da Silva","joao@example.com","12345678901","(11) 99999-9999","Consultor diocesano","Pe.","Diocese Y","Grupo 1","Provisão Diocese X","PROV-2025-001","24/10/2025 18:00:35","JS","Informador","24/10/2025 18:00:35","24/10/2025 18:00:35"

Nota: Este endpoint retorna o arquivo CSV diretamente para download com nome baseado na data atual e colunas em português.

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	CSV gerado com sucesso
401	Token de autenticação inválido ou expirado
500	Erro interno do servidor

Nunciatura Provista