Skip to main content
GET
Listar alunos

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Página (começa em 1). Página além da última devolve data vazio e hasMore false.

Required range: x >= 1
perPage
integer
default:50

Itens por página (1 a 100; default 50).

Required range: 1 <= x <= 100
email
string

Devolve só o aluno com este e-mail, sem diferenciar maiúsculas.

courseId
string

Alunos com matrícula neste curso. Curso de outra loja responde 400.

cohortId
string

Alunos com matrícula nesta turma. Turma de outra loja responde 400.

enrollmentStatus
enum<string>

Alunos com matrícula neste status.

Available options:
ACTIVE,
REVOKED

Response

Lista de alunos

object
enum<string>
required
Available options:
list
data
object[]
required
page
integer
required
perPage
integer
required
total
integer
required
totalPages
integer
required
hasMore
boolean
required