Endpoint que permite a listagem dos clientes
criadas na plataforma da GRAU.
URL: https://api.caf.grautecnico.com.br
O parâmetro offset é uma ferramenta utilizada para controlar a paginação dos
resultados retornados pela nossa API.
Ele define a partir de qual ponto na lista de resultados os dados devem ser retornados.
Exemplo para listar clientes com offset: https://api.caf.grautecnico.com.br/clientes?offset=5
Exemplo para inserir clientes: https://api.caf.grautecnico.com.br/clientes
Métodos: GET e POST
Os Parâmetros id_franquia, data_cadastro_inicio e data_cadastro_fim podem ser enviados
no body da requisição. Assim como o id_franquia e o fone para trazer um cliente em especifico para fazer a listagem (GET).
| Headers | Valor |
|---|---|
| Api-Key | (chave-enviada-por-email) |
{
"id_franquia": {id},
"data_cadastro_inicio": "2024-07-01",
"data_cadastro_fim": "2024-07-31",
"id_marca": {id},
"status_matricula": "N",
"status_agendamento": "Agendado",
"total_agendamentos": 9
},
{
"id_franquia": {id},
"fone": "+55 (81) 99999-9999"
},
{
"id_cliente": {id},
"id_usuario": {id},
"id_franquia" {id},
"nome": "Nome",
"fone": "99999999999",
"data_cadastro": "2024-07-01",
"status_matricula": "N",
"id_curso": {id},
"id_marca": {id},
"status_agendamento": "Agendado",
"total_agendamentos": 9,
"tipo_ultimo_agendamento": "Pendente"
},
{
"cliente": {
"nome": "Cliente teste api",
"id_usuario": 1970,
"id_franquia": 84,
"fone": "81987654001",
"statuspendencia": "Agendado"
},
"matricula": {
"id_origem": 2334,
"tipo_cadastro": "A",
"id_curso": 1,
"data_agendamento": "2025-06-04",
"id_marca": 1,
"turno": "Manhã"
},
"agendamento": {
"idobs": 1,
"tipo_atendimento": "A",
"tipo": "Potencial",
"status": "Agendado",
"data_agendamento": "2025-06-04",
"hora_agendamento": "11:43:00",
"obs": "Lorem ipsum"
}
}