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

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

Status codes

StatusDescrição
200Success
Swagger Logo

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    },
12    {
13      "id": "456",
14      "name": "Maria Silva",
15      "email": "xpto@test.com"
16    }
17  ]
18}