Paginação

Os endpoints de listagem da API retornam coleções de dados paginadas. A resposta sempre segue o mesmo envelope com três seções: data, links e meta.

Formato da resposta paginada

Todos os endpoints de listagem retornam um objeto com a coleção em data e metadados de paginação em links e meta.

Exemplo de resposta paginada 200 OK

{
  "data": [
    {
      "id": "9faea287-2f03-4b26-b234-3d3c1a2bc4e1",
      "name": "Colégio Exemplo",
      "cnpj": "26019466000122"
    },
    {
      "id": "8bcde123-1a02-3c15-a123-2b2b0b1ab3d0",
      // ...
    }
  ],
  "links": {
    "first": "https://toakiescola.com.br/api/v1/partners/.../all?page=1",
    "last": "https://toakiescola.com.br/api/v1/partners/.../all?page=4",
    "prev": null,
    "next": "https://toakiescola.com.br/api/v1/partners/.../all?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "per_page": 25,
    "to": 25,
    "total": 98
  }
}

Campos do `meta`

current_page integer

Número da página atual.

from integer

Índice do primeiro registro desta página (base 1).

last_page integer

Número da última página disponível.

per_page integer

Quantidade máxima de registros por página.

to integer

Índice do último registro desta página (base 1).

total integer

Total de registros disponíveis em todas as páginas.

Campos do `links`

first string

URL da primeira página.

last string

URL da última página.

prev string | null

URL da página anterior. null se estiver na primeira página.

next string | null

URL da próxima página. null se estiver na última página.

Parâmetros opcionais

Alguns endpoints de listagem aceitam parâmetros de query para filtrar os resultados.

page integer

Número da página a ser retornada. Padrão: 1.

with_photo boolean

Quando true, inclui o campo photo em base64 nos objetos retornados. Padrão: true.

Endpoint com parâmetro de query

Listar alunos sem fotos GET

curl "https://toakiescola.com.br/api/v1/partners/school/26019466000122/students/all?with_photo=false" \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"