API de Usuários

Retorna uma linha por aluno que tenha pelo menos uma atribuição de treinamento na organização ou no grupo associado ao cliente de API.

Listar usuários

GET /api/v1/users

Escopo obrigatório: training.read. Consulte Autenticação para obter e usar um token de acesso.

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	Padrão	Descrição
page	inteiro	1	Número da página. Deve ser pelo menos 1.
pageSize	inteiro	1000	Usuários por página. Deve estar entre 1 e 5000.
includeArchived	booleano	false	Use true para incluir atribuições arquivadas ao determinar quais alunos são retornados.

Resposta

{
  "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 do usuário

Campo	Tipo	Descrição
firstName	string ou null	Nome do aluno.
lastName	string ou null	Sobrenome do aluno.
email	string ou null	E-mail do aluno. Quando presente, corresponde ao campo email da API de Registros de Treinamento.
lastLoginUtc	data/hora ou null	Último acesso, em UTC. É null quando o aluno nunca entrou no sistema.
registeredUtc	data/hora ou null	Data e hora do cadastro, em UTC.
lastAssignedUtc	data/hora ou null	Atribuição de treinamento correspondente mais recente, em UTC. Atribuições arquivadas são consideradas somente com includeArchived=true.

Paginação

Os usuários são retornados em ordem estável por e-mail. Continue solicitando páginas até page alcançar totalPages. Se não houver correspondências, data estará vazio e totalPages será 0.

Erros

Status HTTP	Significado
400 Bad Request	Um parâmetro de paginação é inválido.
401 Unauthorized	O token está ausente, é inválido ou expirou.
403 Forbidden	Falta training.read ou o cliente não está mais autorizado para seu escopo.
429 Too Many Requests	O limite compartilhado da API foi excedido.
500 Internal Server Error	Ocorreu um erro inesperado.

Consulte os limites de autenticação para conhecer o limite compartilhado.

OpenAPI

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