Listar alunos

Descrição

Endpoint para listar todos os alunos cadastrados no sistema. Retorna uma lista paginada de alunos com informações completas de cada registro.

📋 Detalhes da Requisição

URL

GET https://seudominio.com/api/students

Headers Obrigatórios

Parâmetros de Query (Opcionais)

Campo	Tipo	Obrigatório	Descrição	Padrão
`page`	int	❌ Não	Número da página (mínimo: 1)	`1`
`limit`	int	❌ Não	Quantidade de registros por página (1-100)	`10`
`search`	string	❌ Não	Termo de busca (nome, sobrenome, email, tel)	-

📤 Respostas da API

✅ Sucesso (200 OK)

{
  "success": true,
  "message": "Lista de alunos recuperada com sucesso",
  "data": {
    "data": [
      {
        "id": 123,
        "nome": "João",
        "sobrenome": "Silva",
        "tipo": "Aluno",
        "nascimento": "1990-05-15",
        "anotacao": "Aluno dedicado",
        "usuario": "joao.silva",
        "email": "joao@email.com",
        "cpf": "123.456.789-00",
        "telefone": "(11) 99999-9999",
        "endereco": "Rua das Flores, 123",
        "cidade": "São Paulo",
        "estado": "SP",
        "pais": "Brasil",
        "...": "..."
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total": 150,
      "total_pages": 15
    }
  }
}

❌ Erro - Token Inválido (401 Unauthorized)

{
  "success": false,
  "message": "Unauthorized - Invalid or missing token",
  "error": "Unauthorized"
}

❌ Erro - Parâmetros Inválidos (400 Bad Request)

{
  "success": false,
  "message": "Parâmetros inválidos",
  "error": "Bad Request"
}

🔍 Campos Retornados

Dados do Aluno

Campo	Tipo	Descrição
`id`	int	ID único do aluno
`nome`	string	Nome do aluno
`sobrenome`	string	Sobrenome do aluno
`tipo`	string	Tipo de usuário (geralmente "Presencial")
`nascimento`	string	Data de nascimento (YYYY-MM-DD)
`anotacao`	string	Anotações sobre o aluno
`usuario`	string	Nome de usuário para login
`email`	string	Email do aluno
`cpf`	string	CPF do aluno
`telefone`	string	Telefone do aluno
`endereco`	string	Endereço completo
`cidade`	string	Cidade
`estado`	string	Estado (UF)
`pais`	string	País
`dataCriado`	string	Data de criação do registro
`cep`	string	CEP
`sexo`	string	Sexo (M/F)
`rg`	string	RG do aluno

Dados do Responsável

Campo	Tipo	Descrição
`nome_responsavel`	string	Nome do responsável
`sobrenome_responsavel`	string	Sobrenome do responsável
`rg_responsavel`	string	RG do responsável
`cpf_responsavel`	string	CPF do responsável
`sexo_responsavel`	string	Sexo do responsável (M/F)
`nascimento_responsavel`	string	Data de nascimento do responsável
`endereco_responsavel`	string	Endereço do responsável
`cidade_responsavel`	string	Cidade do responsável
`estado_responsavel`	string	Estado do responsável
`pais_responsavel`	string	País do responsável
`cep_responsavel`	string	CEP do responsável
`contato_responsavel`	string	Telefone do responsável
`email_responsavel`	string	Email do responsável

Metadados de Paginação

Campo	Tipo	Descrição
`current_page`	int	Página atual
`per_page`	int	Registros por página
`total`	int	Total de registros
`total_pages`	int	Total de páginas

⚠️ Códigos de Status HTTP

Código	Descrição	Quando Ocorre
`200`	Success	Lista recuperada com sucesso
`400`	Bad Request	Parâmetros inválidos (page < 1, limit > 100)
`401`	Unauthorized	Token inválido ou não fornecido
`500`	Internal Server Error	Erro interno do servidor

🎯 Cenários de Uso

Dashboard Administrativo - Listar todos os alunos para gestão

Relatórios - Exportar dados de alunos com paginação

Busca de Alunos - Encontrar alunos específicos por nome/email

Integração com Frontend - Carregar dados para tabelas/lista

Auditoria - Verificar registros de alunos no sistema

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

application/json

Body

Exemplo

{
    "success": true,
    "message": "string",
    "data": {
        "data": [
            {
                "id": 0,
                "nome": "string",
                "sobrenome": "string",
                "tipo": "string",
                "nascimento": "string",
                "anotacao": "string",
                "usuario": "string",
                "email": "string",
                "cpf": "string",
                "telefone": "string",
                "endereco": "string",
                "cidade": "string",
                "estado": "string",
                "pais": "string",
                "dataCriado": "string",
                "cep": "string",
                "sexo": "string",
                "rg": "string",
                "nome_responsavel": "string",
                "sobrenome_responsavel": "string",
                "rg_responsavel": "string",
                "grupo": 0,
                "cpf_responsavel": "string",
                "sexo_responsavel": "string",
                "nascimento_responsavel": "string",
                "endereco_responsavel": "string",
                "cidade_responsavel": "string",
                "estado_responsavel": "string",
                "pais_responsavel": "string",
                "cep_responsavel": "string",
                "contato_responsavel": "string",
                "email_responsavel": "string"
            }
        ],
        "pagination": {
            "current_page": 0,
            "per_page": 0,
            "total": 0,
            "total_pages": 0
        }
    },
    "timestamp": "string",
    "status_code": 0
}

Descrição#

📋 Detalhes da Requisição#

URL#

Headers Obrigatórios#

Parâmetros de Query (Opcionais)#

📤 Respostas da API#

✅ Sucesso (200 OK)#

❌ Erro - Token Inválido (401 Unauthorized)#

❌ Erro - Parâmetros Inválidos (400 Bad Request)#

🔍 Campos Retornados#

Dados do Aluno#

Dados do Responsável#

Metadados de Paginação#

⚠️ Códigos de Status HTTP#

🎯 Cenários de Uso#

Requisição

Exemplos de Requisição

Respostas