Saltar al contenido principal

API de Usuarios

Endpoints para consultar y gestionar usuarios, equipos y sus permisos en SalesOS.

Usuarios

Listar usuarios

GET /v1/users
Parámetros de consulta:
ParámetroTipoDescripción
pagenumberNúmero de página
per_pagenumberRegistros por página
rolestringFiltrar por rol: admin, manager, seller, viewer
team_idstringFiltrar por equipo
statusstringactive, inactive, pending
Ejemplo de respuesta:
{
  "data": [
    {
      "id": "user_xyz789",
      "name": "Carlos Rodríguez",
      "email": "carlos@empresa.com",
      "role": "seller",
      "team_id": "team_001",
      "status": "active",
      "avatar_url": "https://...",
      "created_at": "2026-01-15T08:00:00Z",
      "last_login_at": "2026-03-15T09:30:00Z"
    }
  ]
}

Obtener un usuario

GET /v1/users/:id

Obtener el usuario actual

GET /v1/users/me
Devuelve los datos del usuario autenticado.

Actualizar un usuario

PATCH /v1/users/:id
{
  "name": "Carlos A. Rodríguez",
  "role": "manager",
  "team_id": "team_002"
}
Solo los administradores pueden cambiar roles y asignaciones de equipo de otros usuarios.

Equipos

Listar equipos

GET /v1/teams
Ejemplo de respuesta:
{
  "data": [
    {
      "id": "team_001",
      "name": "Ventas LATAM",
      "leader_id": "user_abc123",
      "member_count": 8,
      "created_at": "2026-01-01T00:00:00Z"
    }
  ]
}

Obtener miembros de un equipo

GET /v1/teams/:id/members

Crear un equipo

POST /v1/teams
{
  "name": "Ventas Enterprise",
  "leader_id": "user_abc123",
  "member_ids": ["user_xyz789", "user_def456"]
}

Agregar miembro a un equipo

POST /v1/teams/:id/members
{
  "user_id": "user_new001"
}

Remover miembro de un equipo

DELETE /v1/teams/:id/members/:user_id

Invitaciones

Enviar invitación

POST /v1/invitations
{
  "email": "nuevo@empresa.com",
  "name": "Ana López",
  "role": "seller",
  "team_id": "team_001"
}

Listar invitaciones pendientes

GET /v1/invitations?status=pending
Los endpoints de gestión de usuarios y equipos requieren permisos de administrador. Asegúrate de que tu token tenga el scope admin o write:users.

Próximos pasos