API de usuarios

Devuelve una fila por alumno que tenga al menos una asignación de formación en la organización o el grupo asociado al cliente de API.

Listar usuarios

GET /api/v1/users

Ámbito requerido: training.read. Consulta Autenticación para obtener y utilizar un token de acceso.

curl --request GET \
  --url "https://courses.e-learningcourses.com/api/v1/users?page=1&pageSize=1000&includeArchived=false" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Accept: application/json"

Parámetros de consulta

Parámetro	Tipo	Predeterminado	Descripción
page	entero	1	Número de página. Debe ser al menos 1.
pageSize	entero	1000	Usuarios por página. Debe estar entre 1 y 5000.
includeArchived	booleano	false	Usa true para incluir asignaciones archivadas al determinar qué alumnos se devuelven.

Respuesta

{
  "data": [
    {
      "firstName": "Alex",
      "lastName": "Morgan",
      "email": "alex.morgan@example.com",
      "lastLoginUtc": "2026-09-18T13:24:10Z",
      "registeredUtc": "2026-08-12T09:15:00Z",
      "lastAssignedUtc": "2026-09-03T08:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "totalRecords": 1,
    "totalPages": 1
  }
}

Campos de usuario

Campo	Tipo	Descripción
firstName	cadena o null	Nombre del alumno.
lastName	cadena o null	Apellidos del alumno.
email	cadena o null	Correo electrónico del alumno. Cuando existe, coincide con el campo email de la API de registros de formación.
lastLoginUtc	fecha-hora o null	Último acceso, en UTC. Es null si el alumno nunca ha iniciado sesión.
registeredUtc	fecha-hora o null	Fecha y hora de registro, en UTC.
lastAssignedUtc	fecha-hora o null	Asignación de formación coincidente más reciente, en UTC. Las asignaciones archivadas solo se consideran con includeArchived=true.

Paginación

Los usuarios se devuelven en un orden estable por correo electrónico. Sigue solicitando páginas hasta que page alcance totalPages. Si no hay coincidencias, data está vacío y totalPages vale 0.

Errores

Estado HTTP	Significado
400 Bad Request	Un parámetro de paginación no es válido.
401 Unauthorized	Falta el token, no es válido o ha caducado.
403 Forbidden	Falta training.read o el cliente ya no está autorizado para su ámbito.
429 Too Many Requests	Se ha superado el límite compartido de la API.
500 Internal Server Error	Se ha producido un error inesperado.

Consulta los límites de autenticación para conocer el límite compartido.

OpenAPI

https://courses.e-learningcourses.com/api/v1/openapi.json