Pular para o conteúdo
Plataforma

Listar alunos com resumo de uso

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/platform/users
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposplatform.read

Alunos = usuários com ao menos uma matrícula (enrollment) em algum curso. Dado GLOBAL da rede — não filtra por workspace. Exclusivo da conta Accelera: a chave precisa do escopo platform.read E ser o workspace da conta Accelera; qualquer outra chave com o escopo leva 403 forbidden_platform.

lastLoginAt/lastActiveAt vêm da sessão (Better Auth): login mais recente e última vez visto; null = nunca logou. enrolledCourses/completedCourses/certificates são contadores ALL-TIME (não filtram por período). q busca por nome ou e-mail (contém, sem diferenciar maiúscula; no nome, ignora também o acento: "geor" acha "Geórgia" e "Georgia"; % e _ são texto, não curinga). activeSince/activeBefore (ISO-8601) recortam por lastActiveAt: activeSince é >=, activeBefore é <; aluno que nunca logou não casa com nenhum dos dois. Paginação por cursor keyset (createdAt, id); limit até 500.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • qstringopcional
    • tamanho 1–200
  • activeSincestringopcional
  • activeBeforestringopcional
  • cursorstringopcional
  • limitintegeropcional
    • padrão 50
    • faixa 1–500

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de alunos (usuários com ao menos uma matrícula) com os contadores ALL-TIME de cursos matriculados, concluídos e certificados, mais os carimbos de último login e de última atividade. Busca sem resultado devolve data: [], nunca 404.

  • Cada item — V1PlatformUser

    • idstring
    • namestring
    • emailstring
    • createdAtstring
    • lastLoginAtstring | null
    • lastActiveAtstring | null
    • enrolledCoursesinteger
    • completedCoursesinteger
    • certificatesinteger
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.