API de Usuários
Endpoints para consultar informações de usuários e equipes programaticamente.
Listar usuários
Parâmetros de query:
| Parâmetro | Tipo | Descrição |
|---|
page | integer | Página atual |
per_page | integer | Itens por página |
role | string | Filtrar por cargo: admin, manager, seller |
team_id | uuid | Filtrar por equipe |
status | string | active, inactive |
search | string | Busca por nome ou e-mail |
{
"data": [
{
"id": "uuid",
"name": "Carlos Mendes",
"email": "carlos@empresa.com",
"role": "seller",
"team_id": "uuid",
"team_name": "Equipe Sul",
"status": "active",
"avatar_url": "https://...",
"created_at": "2026-01-15T10:00:00Z"
}
],
"pagination": { ... }
}
Buscar usuário por ID
Retorna dados completos do usuário, incluindo métricas de performance e badges.
Usuário atual
Retorna os dados do usuário autenticado pelo token JWT.
Listar equipes
Resposta (200):
{
"data": [
{
"id": "uuid",
"name": "Equipe Sul",
"manager_id": "uuid",
"manager_name": "Ana Oliveira",
"members_count": 8,
"created_at": "2026-01-10T09:00:00Z"
}
]
}
Buscar equipe por ID
Retorna dados da equipe com lista completa de membros.
Membros de uma equipe
GET /v1/teams/:id/members
Métricas do usuário
GET /v1/users/:id/metrics
| Parâmetro | Tipo | Descrição |
|---|
period | string | week, month, quarter, year |
start_date | date | Data de início personalizada |
end_date | date | Data de fim personalizada |
{
"data": {
"deals_won": 12,
"deals_lost": 5,
"revenue": 450000.00,
"conversion_rate": 0.71,
"average_ticket": 37500.00,
"average_cycle_days": 22,
"leads_contacted": 48,
"activities_count": 156,
"ranking_position": 3,
"points": 2850
}
}
Endpoints de escrita para usuários (criar, editar, desativar) estão disponíveis apenas para tokens com role de administrador.
A API de usuários retorna apenas dados do tenant associado ao token. Não é possível acessar dados de outras empresas.
Próximos passos
