Exportar Usuários de um Grupo (CSV)

Descrição

Exporta todos os usuários vinculados a um grupo específico no formato CSV, incluindo o nome do grupo em cada linha. O arquivo é baixado automaticamente.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/group-users/export/csv/{groupId}

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Conteúdo do Arquivo CSV

O arquivo CSV conterá as seguintes colunas:

  • user_id — ID do usuário
  • first_name — Primeiro nome
  • last_name — Último nome
  • email — E-mail
  • group_name — Nome do grupo

O nome do arquivo gerado será no formato: {nome_do_grupo}_{data}_users.csv. Exemplo: gestores_2025-04-29_users.csv.

Sucesso - 200

O download do CSV será iniciado automaticamente se o grupo e os usuários forem encontrados.

Erro - 422 (Group ID não informado)

{
  "status": 422,
  "error": "Group ID is required."
}

Erro - 404 (Grupo ou Usuários não encontrados)

{
  "status": 404,
  "error": "Group not found."
}
{
  "status": 404,
  "error": "No users found in this group."
}

Erro - 500 (Erro interno do servidor)

{
  "status": 500,
  "error": "Failed to export users."
}

Códigos de Resposta

  • 200 - CSV gerado e download iniciado
  • 422 - ID do grupo não enviado
  • 404 - Grupo ou usuários não encontrados
  • 500 - Erro interno ao exportar