Listar alunos da escola
Listar alunos da escola
Required scopes:alpaclass_student_read
GET
https://api.eduzz.com/alpaclass/v1/producer/teams/:slug/students
Path params
slug
Slug da escola
Query params
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
sort
string
Ordenação dos itens podendo ter várias ordenações, seguindo o seguinte padrão: campo:ordenação Ex.: name:asc,email:desc
id
string
Id do aluno
email
string
E-mail do aluno
document
string
Documento do aluno
startDate
datetime
Data de início do cadastro dos alunos
endDate
datetime
Data de fim do cadastro dos alunos
isFrozen
boolean
Status de congelamento do aluno
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
totalItems
number
Número total de items
items
array of object
Alunos da escola
items[n].id
string
Id do aluno
items[n].name
string
Nome do aluno
items[n].email
string
Email do aluno
items[n].createdAt
datetime
Data de criação do aluno
Status codes
| Status | Descrição |
| 200 | Success |
Exemplos
1curl --request GET \
2 --url 'https://api.eduzz.com/alpaclass/v1/producer/teams/123/students' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "pages": 2,
3 "page": 1,
4 "itemsPerPage": 2,
5 "totalItems": 3,
6 "items": [
7 {
8 "id": "123",
9 "name": "João Carlos",
10 "email": "test@test.com",
11 "createdAt": "2023-01-01T00:00:00Z"
12 },
13 {
14 "id": "456",
15 "name": "Maria Silva",
16 "email": "xpto@test.com",
17 "createdAt": "2023-01-01T00:00:00Z"
18 }
19 ]
20}