GET
/
api
/
v1
/
reports
/
students
/
not-enrolled
Usuários Não Matriculados em Nenhum Curso
curl --request GET \
  --url https://trialprod.app.toolzz.com.br/api/v1/reports/students/not-enrolled \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "birthDate": "<string>",
      "document": "<string>",
      "mailAddress": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "lastActivity": 123,
      "lastLogin": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Parâmetros

page
number
Especifica o número da página de resultados a ser retornada.
perPage
number
Define o número de usuários a serem exibidos por página nos resultados da consulta.
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.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através 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.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
data
array
Lista de usuários não matriculados.
URLs de navegação entre páginas do relatório.
meta
object
Metainformações sobre a paginação do resultado.