Agenda

Listar agenda.

POST · API de Integração v2

POST/v2/agenda/consulta

Grade do calendário — compromissos/expedientes/audiências/diligências combinados. Filtros no corpo, paginação por query param.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de consulta2

paginainteger

Página (1-based)

padrão: 1

tamanhointeger

Itens por página; use 0 para retornar toda a janela da agenda

padrão: 15

Corpo da requisiçãoobrigatório

request

application/json

agendaAudienciasinteger

1 = inclui audiências no resultado

Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).

formato: int32

agendaCompromissosinteger

1 = inclui compromissos no resultado

Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).

formato: int32

agendaDiligenciainteger

1 = inclui diligências no resultado

Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).

formato: int32

agendaExpedientesinteger

1 = inclui expedientes no resultado

Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).

formato: int32

agendaItemIdinteger

ID de um item específico da agenda; usado apenas em consultas internas de detalhe

formato: int64

agendaTarefasAtrasadasstring

agendaTarefasCanceladasstring

agendaTarefasCompartilhadasstring

agendaTarefasConcluidastring

agendaTarefasDuplocheckstring

agendaTarefasPendentesstring

clientestring

columnstring

endstring

Fim do período (yyyy-MM-dd)

exemplo: 2026-07-31

equipestring

estadostring

filtroDatastring

filtroVisualizacaostring

Filtro da leitura do usuário autenticado: visualizados ou nao_visualizados

valores: nao_visualizados · visualizados

numeroProcessostring

ordemstring

Ordenação da ficha do processo pela data do prazo

valores: ASC · DESC

prioridadestring

seSouResponsavelstring

Restringe aos compromissos do próprio usuário autenticado

selecionaTipoDeTarefainteger

formato: int32

situacaointeger

formato: int64

sortFieldstring

sortOrderstring

startstring

Início do período (yyyy-MM-dd)

exemplo: 2026-07-01

statusstring

tipostring

tribunalstring

userstring

userb2string

Respostas2

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "content": [
    {
      "arquivos": "string",
      "arquivos_url": "string",
      "audiencia": {},
      "comentarios": {},
      "compromisso": {},
      "concluido": 1,
      "data_fatal": "string",
      "data_fim": "string",
      "data_inicio": "string",
      "diligencia": {},
      "expediente": {},
      "id": 1,
      "marcador": {},
      "observacao": "string",
      "processo": {},
      "publicacao_id": "string",
      "responsaveis": {},
      "tipo": "string",
      "tipo_compromisso": {},
      "titulo": "string",
      "visualizacao": {}
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 1,
  "totalPages": 1
}

Contrato de respostas

200Página de itens da agenda.

Página de itens da agenda.

application/json

contentAgendaItemResponse[]

Ver propriedades

arquivosstring

arquivos_urlstring

audienciaobject

comentariosobject

compromissoobject

concluidointeger

formato: int32

data_fatalstring

data_fimstring

data_iniciostring

diligenciaobject

expedienteobject

idinteger

formato: int64

marcadorobject

observacaostring

processoobject

publicacao_idstring

responsaveisobject

tipostring

tipo_compromissoobject

titulostring

visualizacaoobject

pageinteger

formato: int32

perPageinteger

formato: int32

totalinteger

formato: int64

totalPagesinteger

formato: int32

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

curl --request POST \
  --url 'https://api.expedit.com.br/v2/agenda/consulta?pagina=1&tamanho=15' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "agendaAudiencias": 0,
  "agendaCompromissos": 0,
  "agendaDiligencia": 0,
  "agendaExpedientes": 0
}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{
  "agendaAudiencias": 0,
  "agendaCompromissos": 0,
  "agendaDiligencia": 0,
  "agendaExpedientes": 0
}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "content": [
    {
      "arquivos": "string",
      "arquivos_url": "string",
      "audiencia": {},
      "comentarios": {},
      "compromisso": {},
      "concluido": 1,
      "data_fatal": "string",
      "data_fim": "string",
      "data_inicio": "string",
      "diligencia": {},
      "expediente": {},
      "id": 1,
      "marcador": {},
      "observacao": "string",
      "processo": {},
      "publicacao_id": "string",
      "responsaveis": {},
      "tipo": "string",
      "tipo_compromisso": {},
      "titulo": "string",
      "visualizacao": {}
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 1,
  "totalPages": 1
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.