Skip to main content
GET
/
api
/
v1
/
schools
/
{schoolId}
/
classrooms
Listar Turmas
curl --request GET \
  --url https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms
{
  "success": true,
  "data": [
    {
      "id": 123,
      "schoolId": 123,
      "title": "<string>",
      "code": "<string>",
      "image": "<string>",
      "course": "<string>",
      "group": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "subgroups": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "specialties": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "trails": [
        {}
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "per_page": 123,
    "current_page": 123,
    "last_page": 123,
    "first_page_url": "<string>",
    "last_page_url": "<string>",
    "next_page_url": "<string>",
    "prev_page_url": "<string>",
    "from": 123,
    "to": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Parâmetros

​
schoolId
string
required
Identificador da escola à qual as turmas a serem listadas estão associadas.
​
code
string
Filtra as turmas a serem listadas pelo código.
​
title
string
Filtra as turmas a serem listadas pelo título.
​
page
string
Número da página dos registros de turmas a ser exibida.
​
perPage
number
Número de registros a serem exibidos por página. O valor máximo permitido é 100 registros.
Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
​
success
boolean
Indica se a requisição foi bem-sucedida.
​
data
array
Lista de turmas.
​
meta
object
Metadados sobre a resposta.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido por meio do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.