Exportar Lista de Usuários em CSV

Gera e baixa um arquivo CSV com a lista de usuários 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 administradores aplicando os mesmos filtros da listagem padrão. O CSV inclui:

Formato CSV compatível com Excel e Google Sheets
Codificação UTF-8 com BOM para suporte completo a caracteres especiais
Dados completos de todos os usuários administradores (sem paginação)
Colunas organizadas: Nome, Sobrenome, Email, Verificação Email (dd/mm/aaaa hh:mm:ss), Data Criação (dd/mm/aaaa hh:mm:ss), Data Atualização (dd/mm/aaaa hh:mm:ss), Role
Suporte aos mesmos filtros da listagem (role, group_id, questionary_status, search)
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/users/export/csv

Parâmetros de Query

Campo	Tipo	Obrigatório	Descrição
role	string	Não	Filtrar por role (admin, informador)
group_id	uuid	Não	Filtrar por grupo eclesiástico (UUID)
questionary_status	string	Não	Filtrar por status do questionário (Pendente, Em andamento, Concluído)
search	string	Não	Buscar por nome ou email

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>
Accept	text/csv

Estrutura do CSV

Colunas do Arquivo CSV:

Nome: Primeiro nome do usuário

Sobrenome: Último nome do usuário

Email: Endereço de email

Verificação Email: Data de verificação do email (dd/mm/aaaa hh:mm:ss)

Data Criação: Data de cadastro do usuário (dd/mm/aaaa hh:mm:ss)

Data Atualização: Última modificação do usuário (dd/mm/aaaa hh:mm:ss)

Role: Papel do usuário (Admin/Informador)

Respostas

Sucesso - 200

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

"Nome","Sobrenome","Email","Verificação Email","Data Criação","Data Atualização","Role"
"João","Silva","joao.silva@diocese.com.br","21/01/2025 17:00:39","21/01/2025 17:00:39","21/01/2025 17:00:39","Informador"

Nota: O endpoint retorna um arquivo CSV diretamente. O nome do arquivo segue o padrão "lista-usuarios-YYYY-MM-DD.csv" com a data atual de geração.

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 e baixado com sucesso
401	Token inválido ou expirado

Nunciatura Provista