To Aqui - Sandbox

O modelo lista de exercícios

id uuid

Identificador da lista.

status string

draft, submitted, approved ou denied.

subject / grade / classrooms object

Disciplina, série e turmas atribuídas.

created_by object|null

Professor que criou a lista.

due_date date|null

Prazo de entrega.

has_points boolean

Se a lista vale nota.

exercises_count / submissions_count integer

Quantidade de questões e de tentativas.

O modelo lista de exercícios

{
  "id": "01a0070c-efd1-7012-9d01-6203d7c9d200",
  "title": "Frações — revisão",
  "description": "Lista de revisão para a avaliação bimestral.",
  "status": "approved",
  "subject": {
    "id": "f87f7598-f897-4593-b3ae-d093f80fccac",
    "name": "Matemática"
  },
  "grade": {
    "id": "019f051a-921b-70c9-b645-e45d945764ae",
    "name": "5º Ano"
  },
  "classrooms": [
    {
      "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
      "name": "5º Ano A"
    }
  ],
  "created_by": {
    "id": "019e6e4b-3235-727f-b423-89694ac61dea",
    "name": "Carlos Almeida"
  },
  "due_date": "2026-10-09",
  "has_points": true,
  "exercises_count": 8,
  "submissions_count": 27,
  "submitted_at": "2026-09-28T18:00:00-03:00",
  "approved_at": "2026-09-29T08:30:00-03:00",
  "created_at": "2026-09-27T14:00:00-03:00"
}

GET /v1/partners/school/{cnpj}/exercise-groups/all

Listar listas de exercícios

Listas de exercícios da escola, da mais recente para a mais antiga. Paginado (25 por página).

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Filtros (query string)

status string opcional

draft, submitted (aguardando a coordenação), approved ou denied.

subject_id uuid opcional

Somente uma disciplina.

grade_id uuid opcional

Somente uma série.

classroom_id uuid opcional

Somente as listas atribuídas a uma turma.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

422

Parâmetros inválidos — veja errors.

Requisição GET

GET /v1/partners/school/{cnpj}/exercise-groups/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-groups/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-groups/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-groups/all', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": [
    {
      "id": "01a0070c-efd1-7012-9d01-6203d7c9d200",
      "title": "Frações — revisão",
      "description": "Lista de revisão para a avaliação bimestral.",
      "status": "approved",
      "subject": {
        "id": "f87f7598-f897-4593-b3ae-d093f80fccac",
        "name": "Matemática"
      },
      "grade": {
        "id": "019f051a-921b-70c9-b645-e45d945764ae",
        "name": "5º Ano"
      },
      "classrooms": [
        {
          "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
          "name": "5º Ano A"
        }
      ],
      "created_by": {
        "id": "019e6e4b-3235-727f-b423-89694ac61dea",
        "name": "Carlos Almeida"
      },
      "due_date": "2026-10-09",
      "has_points": true,
      "exercises_count": 8,
      "submissions_count": 27,
      "submitted_at": "2026-09-28T18:00:00-03:00",
      "approved_at": "2026-09-29T08:30:00-03:00",
      "created_at": "2026-09-27T14:00:00-03:00"
    }
  ],
  "links": { /* first, prev, next */ },
  "meta": { "current_page": 1, "per_page": 25 }
}

{
  "success": false,
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/exercise-group/{id}

Obter lista de exercícios

Uma lista com as questões em ordem. Tipos: introduction, discursive, multiple_choice e interactive.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

id uuid obrigatório

UUID da lista de exercícios.

O gabarito nunca é exposto: as alternativas vêm sem a indicação de correta e as questões discursivas vêm sem a resposta-modelo.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/exercise-group/{id}

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id} \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id}', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id}', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": {
    "id": "01a0070c-efd1-7012-9d01-6203d7c9d200",
    "title": "Frações — revisão",
    "description": "Lista de revisão para a avaliação bimestral.",
    "status": "approved",
    "subject": {
      "id": "f87f7598-f897-4593-b3ae-d093f80fccac",
      "name": "Matemática"
    },
    "grade": {
      "id": "019f051a-921b-70c9-b645-e45d945764ae",
      "name": "5º Ano"
    },
    "classrooms": [
      {
        "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
        "name": "5º Ano A"
      }
    ],
    "created_by": {
      "id": "019e6e4b-3235-727f-b423-89694ac61dea",
      "name": "Carlos Almeida"
    },
    "due_date": "2026-10-09",
    "has_points": true,
    "exercises_count": 8,
    "submissions_count": 27,
    "submitted_at": "2026-09-28T18:00:00-03:00",
    "approved_at": "2026-09-29T08:30:00-03:00",
    "created_at": "2026-09-27T14:00:00-03:00",
    "exercises": [
      {
        "id": "01a0070d-0000-7000-8000-000000000801",
        "type": "multiple_choice",
        "position": 1,
        "statement": "Quanto é 1/2 + 1/4?",
        "hint": "Iguale os denominadores.",
        "points": 1,
        "options": [
          {
            "id": "01a0070d-0000-7000-8000-000000000811",
            "position": 0,
            "content": "3/4"
          },
          {
            "id": "01a0070d-0000-7000-8000-000000000812",
            "position": 1,
            "content": "2/6"
          }
        ]
      }
    ]
  }
}

{
  "success": false,
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/exercise-group/{id}/submissions

Listar resultados

Tentativas dos alunos na lista — andamento, nota e tempo gasto. Paginado.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

id uuid obrigatório

UUID da lista de exercícios.

Filtros (query string)

status string opcional

in_progress, submitted, grading, awaiting_correction ou corrected.

enrollment_number string opcional

Número de matrícula do aluno.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

422

Parâmetros inválidos — veja errors.

Requisição GET

GET /v1/partners/school/{cnpj}/exercise-group/{id}/submissions

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id}/submissions \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id}/submissions', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/exercise-group/{id}/submissions', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": [
    {
      "id": "01a0070e-0000-7000-8000-000000000901",
      "student": {
        "id": "019e6e4b-6bba-734d-be16-c6826c795d9d",
        "name": "Ana Beatriz Costa"
      },
      "status": "corrected",
      "score": 7.5,
      "max_score": 8,
      "total_time_seconds": 1260,
      "started_at": "2026-10-01T19:02:00-03:00",
      "submitted_at": "2026-10-01T19:23:00-03:00",
      "corrected_at": "2026-10-02T08:10:00-03:00"
    }
  ],
  "links": { /* first, prev, next */ },
  "meta": { "current_page": 1, "per_page": 25 }
}

{
  "success": false,
  "message": "Escola não encontrada."
}

Exercícios

O modelo lista de exercícios

Listar listas de exercícios

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Obter lista de exercícios

Parâmetros de rota

Códigos de resposta

Listar resultados

Parâmetros de rota

Filtros (query string)

Códigos de resposta