Consultar a agenda com filtros
Monte o corpo de POST /v2/agenda/consulta, selecione os tipos de atividade com flags numéricos e use a paginação da agenda.
Por que a consulta usa POST?
POST /v2/agenda/consulta recebe filtros estruturados no corpo e paginação na query. É a operação de consulta do calendário; não a confunda com POST /v2/agenda, usado para criar uma atividade.
Confira os campos aceitos na referência de Agenda. O contexto do escritório vem de X-API-Key.
Selecione os tipos de atividade
Os campos agendaAudiencias, agendaCompromissos, agendaDiligencia e agendaExpedientes são inteiros. Envie 1 para incluir um tipo e 0 para não incluí-lo. No explorador, os checkboxes produzem esses números automaticamente.
O exemplo inclui compromissos e omite filtros opcionais. Revise período, responsáveis e demais filtros conforme a operação e seu caso de uso.
{
"agendaAudiencias": 0,
"agendaCompromissos": 1,
"agendaDiligencia": 0,
"agendaExpedientes": 0
}Controle a janela e o tamanho do resultado
Use pagina=1&tamanho=15 para começar. tamanho=0 solicita toda a janela consultada; prefira páginas para resultados grandes. Não reutilize automaticamente os nomes page e perPage de Processos.
Leia o schema de resposta da operação e diferencie uma coleção vazia de uma falha. Para os envelopes de outros recursos, consulte Paginação e filtros.
POST https://api.expedit.com.br/v2/agenda/consulta?pagina=1&tamanho=15Integre a consulta com segurança
O explorador solicita confirmação para operações POST; revise o ambiente e o JSON antes de enviar. Para um cliente no navegador, o domínio precisa estar autorizado no CORS da API. Em um serviço backend, guarde a chave fora do código público e defina timeout.
Consulte Autenticação e Erros e limites para tratamento das falhas. Webhooks dependem de habilitação própria e não são pré-requisito desta consulta.