Super Admin

Endpoints exclusivos para Super Administradores. Gerencie todas as contas (tenants), usuarios do sistema, e acesse analytics globais da plataforma.

Acesso Restrito

Todos os endpoints desta secao requerem permissao de Super Admin (isSuperAdmin: true).

Gerenciar Contas

GET/api/superadmin/accounts

Lista todas as contas (tenants) do sistema.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`isActive`(query)	`boolean`	Nao	Filtrar por status
`search`(query)	`string`	Nao	Buscar por nome

bash

curl -s "https://flow.seudominio.com/api/superadmin/accounts?isActive=true" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Lista de contas

json

{
  "success": true,
  "data": {
    "accounts": [
      {
        "id": "clx...",
        "name": "Empresa ABC",
        "slug": "empresa-abc",
        "cpf": null,
        "cnpj": "12.345.678/0001-90",
        "isActive": true,
        "usersCount": 3,
        "createdAt": "2025-06-01T00:00:00Z"
      }
    ],
    "total": 15,
    "page": 1,
    "limit": 20
  }
}

POST/api/superadmin/accounts

Cria uma nova conta (tenant).

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da conta
`slug`	`string`	Nao	Slug unico
`cpf`	`string`	Nao	CPF do titular
`cnpj`	`string`	Nao	CNPJ da empresa

bash

curl -X POST "https://flow.seudominio.com/api/superadmin/accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Nova Empresa Ltda",
    "cnpj": "98.765.432/0001-10"
  }'

GET/api/superadmin/accounts/{accountId}

Retorna detalhes de uma conta.

PUT/api/superadmin/accounts/{accountId}

Atualiza dados de uma conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome
`cpf`	`string`	Nao	CPF
`cnpj`	`string`	Nao	CNPJ
`isActive`	`boolean`	Nao	Status da conta

DELETE/api/superadmin/accounts/{accountId}

Remove uma conta e todos os dados associados.

Acao Irreversivel

Esta acao remove permanentemente todos os dados da conta (clientes, transacoes, etc).

Gerenciar Usuarios

GET/api/superadmin/users

Lista todos os usuarios do sistema.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`isActive`(query)	`boolean`	Nao	Filtrar por status
`isSuperAdmin`(query)	`boolean`	Nao	Filtrar super admins
`search`(query)	`string`	Nao	Buscar por nome ou email

bash

curl -s "https://flow.seudominio.com/api/superadmin/users?isActive=true" \
  -H "Authorization: Bearer $TOKEN" | jq .

POST/api/superadmin/users

Cria um novo usuario no sistema.

Body

Nome	Tipo	Obrigatorio	Descricao
`email`	`string`	Sim	Email do usuario
`password`	`string`	Sim	Senha (min 8 caracteres)
`fullName`	`string`	Nao	Nome completo
`isSuperAdmin`	`boolean`	Nao	Definir como super admin

bash

curl -X POST "https://flow.seudominio.com/api/superadmin/users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "usuario@empresa.com",
    "password": "senha_segura_123",
    "fullName": "Joao Silva"
  }'

GET/api/superadmin/users/{userId}

Retorna detalhes de um usuario com suas memberships.

PUT/api/superadmin/users/{userId}

Atualiza dados de um usuario.

Body

Nome	Tipo	Obrigatorio	Descricao
`fullName`	`string`	Nao	Nome completo
`isActive`	`boolean`	Nao	Status
`isSuperAdmin`	`boolean`	Nao	Super admin

DELETE/api/superadmin/users/{userId}

Remove um usuario do sistema.

POST/api/superadmin/users/{userId}/avatar

Faz upload de avatar para um usuario.

bash

curl -X POST "https://flow.seudominio.com/api/superadmin/users/clx123/avatar" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@/path/to/avatar.jpg"

Usuarios da Conta

Gerencie a associacao entre usuarios e contas (tenants).

POST/api/superadmin/accounts/{accountId}/users

Adiciona um usuario a uma conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`userId`	`string`	Sim	ID do usuario
`role`	`string`	Sim	admin ou agent

bash

curl -X POST "https://flow.seudominio.com/api/superadmin/accounts/clx-account/users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "userId": "clx-user", "role": "admin" }'

PUT/api/superadmin/accounts/{accountId}/users/{userId}/role

Altera o papel de um usuario em uma conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`role`	`string`	Sim	admin ou agent

PATCH/api/superadmin/accounts/{accountId}/users/{userId}/toggle-status

Ativa/desativa um usuario em uma conta especifica.

DELETE/api/superadmin/accounts/{accountId}/users/{userId}

Remove um usuario de uma conta.

Estatisticas

GET/api/superadmin/stats

Estatisticas gerais do sistema.

200Estatisticas do sistema

json

{
  "success": true,
  "data": {
    "totalAccounts": 15,
    "activeAccounts": 12,
    "totalUsers": 45,
    "activeUsers": 38,
    "totalClients": 320,
    "totalTransactions": 5800
  }
}

KPIs do Sistema

GET/api/superadmin/kpis/overview

Metricas de overview do sistema.

GET/api/superadmin/kpis/growth

Dados de crescimento da plataforma.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`months`(query)	`integer`	Nao	Numero de meses(default: `6`)

GET/api/superadmin/kpis/top-accounts

Top contas por receita.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`limit`(query)	`integer`	Nao	Quantidade(default: `10`)

GET/api/superadmin/kpis/accounts-ltv

LTV analytics de contas.

GET/api/superadmin/kpis/clients-health

Saude dos clientes.

GET/api/superadmin/kpis/users-analytics

Analytics de usuarios.

GET/api/superadmin/kpis/system-health

Saude do sistema.

GET/api/superadmin/kpis/new-accounts

Novas contas do mes.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`limit`(query)	`integer`	Nao	Quantidade(default: `10`)

GET/api/superadmin/kpis/new-users

Novos usuarios do mes.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`limit`(query)	`integer`	Nao	Quantidade(default: `10`)