Endpoint que permite a listagem dos agendamentos
criadas na plataforma da GRAU.
URL: https://api.caf.grautecnico.com.br
URL para listar e inserir os agendamentos https://api.caf.grautecnico.com.br/agendamentos
Métodos: GET e POST
Os Parâmetros id_franquia e id_cliente são obrigatorios no body da requisição.
A busca da lista de agendamentos é paginada. O endpoint
é limitado a 100 registros por página.
| Headers | Valor |
|---|---|
| Api-Key | (chave-enviada-por-email) |
{
"id_franquia": {id},
"id_cliente": {id},
}
{
"id_cliente": {id},
"id_usuario": {id},
"id_pendencia" {id},
"obs": "TESTE",
"tipo_agendamento": "Pendente",
"tipo_cadastro": "V",
"data": "2019-09-16",
"data_registro": "2022-09-16",
"hora_registro": "10:02:32",
"status:" "finalizado"
},
O campo look é opcional e do tipo numérico e deve conter apenas dois valores possíveis: 1 ou 0
O campo tipo é do tipo texto (string) e também possui valores limitados,
representando o tipo do atendimento: "Pendente" ou "Potencial" .
O campo status é do tipo texto (string) e também possui valores limitados,
representando o status do atendimento: "Agendado" ou "Finalizado" .
{
"id_cliente": 4107231,
"id_matricula": 4107223,
"id_usuario": 1970,
"id_franquia": 84,
"idobs": 1,
"tipo_atendimento": "A",
"tipo": "Pendente",
"look": 0,
"status": "Agendado",
"data_agendamento": "2025-06-04",
"hora_agendamento": "15:00:00",
"obs": "Tentando novamente 2"
}
O atendimento só pode ser finalizado quando o idobs for do tipo 'Finalizado' (consulte documentação) e o status 'Finalizado'.
{
"id_cliente": 4107231,
"id_matricula": 4107223,
"id_usuario": 1970,
"id_franquia": 84,
"idobs": 1,
"tipo_atendimento": "A",
"tipo": "Pendente",
"look": 0,
"status": "Finalizado",
"data_agendamento": "2025-06-04",
"hora_agendamento": "15:00:00",
"obs": "Tentando novamente 2"
},
{
"id_cliente": 4107231,
"id_franquia": 84,
"look": 0,
"obs": "Tentando novamente 2"
},
Para favoritar os campos são 1 e 0.
{
"look": 0,
},