Leads de alunos

Corresponde à tela Leads de alunos. Um lead de aluno guarda a pessoa interessada em um curso, com a procedência do contato, a situação e os dados de contato. Os cursos de interesse e o histórico de contatos do lead têm páginas próprias: Cursos e Contatos.

Endpoints

Método	Caminho	Descrição
GET	/crm/students-leads	Lista os leads de alunos
POST	/crm/students-leads	Cadastra um lead de aluno
GET	/crm/students-leads/{uuid}	Consulta um lead de aluno
PUT	/crm/students-leads/{uuid}	Altera um lead de aluno
DELETE	/crm/students-leads/{uuid}	Apaga um lead de aluno
GET	/crm/students-leads/situations	Lista as situações do lead (apoio)

GET /crm/students-leads

Lista os leads de alunos da empresa cliente, do cadastro mais recente para o mais antigo, pela data do lead.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre: nome do interessado, procedência, telefones, e-mail, estado, nome do aluno vinculado, curso de interesse, observações do curso e nome de quem criou ou alterou o lead
provenance_id	Id da procedência
provenance	Texto da procedência (contém)
situation_id	Id da situação
situation	Texto da situação (contém)
city	Cidade (contém)
state	Estado (contém)
course_id	Id de um curso de interesse do lead
course	Texto no nome ou na sigla de um curso de interesse
start_date	Data inicial do cadastro do lead (AAAA-MM-DD)
end_date	Data final do cadastro do lead (AAAA-MM-DD)
user_create	Nome de quem cadastrou o lead (contém)
not_students_leads_ids	Lista de ids de leads a deixar de fora do resultado
per_page, page	Paginação, conforme Convenções

Exemplo

curl "https://api.pedagogo.app/crm/students-leads?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

Resposta (200): a lista de leads, sem per_page, ou a página de leads, com per_page. Cada lead traz a procedência, a situação, o nome do aluno vinculado, quando houver, e os nomes de quem criou e de quem alterou.

POST /crm/students-leads

Cadastra um lead de aluno. O código do lead é gerado pelo sistema.

Corpo

Campo	Obrigatório	Tipo	Descrição
provenance_id	Sim	inteiro	Procedência do contato (id da lista de procedências)
date	Sim	data	Data do cadastro do lead
interested	Sim	texto	Nome da pessoa interessada
customer_vendor_student_id	Não	inteiro	Id do aluno cadastrado vinculado ao lead
situation_id	Não	inteiro	Situação do lead, equivalente ao campo Status da tela (id da lista de situações)
phonenumber	Não	texto	Telefone
cellphone	Não	texto	Celular
email	Não	texto	E-mail
city	Não	texto	Cidade
state	Não	texto	Estado
observations	Não	texto	Observações

Exemplo

curl -X POST https://api.pedagogo.app/crm/students-leads \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "provenance_id": 1,
    "date": "2026-11-11",
    "interested": "Interessado exemplo",
    "email": "[email protected]"
  }'

Resposta (201): o lead criado, com o uuid e o code.

GET /crm/students-leads/{uuid}

Consulta um lead de aluno pelo uuid. Resposta (200): o lead, com os mesmos campos da listagem.

PUT /crm/students-leads/{uuid}

Altera um lead de aluno. Envie apenas os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
provenance_id	Não	inteiro	Procedência do contato
customer_vendor_student_id	Não	inteiro	Id do aluno cadastrado vinculado ao lead
situation_id	Não	inteiro	Situação do lead
date	Não	data	Data do cadastro do lead
interested	Não	texto	Nome da pessoa interessada
phonenumber	Não	texto	Telefone
cellphone	Não	texto	Celular
email	Não	texto	E-mail
city	Não	texto	Cidade
state	Não	texto	Estado
observations	Não	texto	Observações

Resposta (200): o lead alterado.

Consultar e apagar

GET /crm/students-leads/{uuid} traz o lead, como descrito acima. DELETE /crm/students-leads/{uuid} remove o lead. Resposta (200).

GET /crm/students-leads/situations

Lista as situações do lead de aluno, para preencher o campo situation_id. Resposta (200): a lista de situações.