Skip to content

Lista os processos de uma cidade em lote

Request

Lista os processos de uma cidade em lote, filtrando por período e, opcionalmente, por assunto (typeId). Substitui o padrão de consultar um processo por vez: use esta rota para varrer o conjunto (carga inicial ou sincronização) e, quando precisar do conteúdo completo de um processo específico, chame GET /hub-api/document/json com o id retornado aqui.

O retorno é enxuto: identificação, status, assunto e datas. Os dois blocos pesados — timeline (movimentações) e lastVersion (última versão do formulário) — são controlados pelo parâmetro include.

Qual data o filtro usa (dateField):

  • created (padrão) — processos protocolados no período.
  • finished — processos encerrados no período. Processo reaberto não aparece.
  • updated — processos cuja última movimentação caiu no período, inclusive processos antigos que voltaram a se mexer. É o filtro para sincronização incremental ("o que mudou desde X").

Paginação: a resposta traz nextCursor. Repita a mesma requisição acrescentando cursor=<nextCursor> até receber nextCursor: null. O cursor é opaco — apenas repasse o valor recebido, sem tentar construí-lo, e não altere os filtros no meio de uma varredura.

Escopo por cidade: a cidade é sempre a da API Key da cidade. Um cityId informado por essas chaves é ignorado.

Use janelas curtas. O período aceito chega a 366 dias, mas o custo da consulta cresce com a quantidade de processos existentes no período — e não com o limit. Em cidades de volume alto, janelas longas podem exceder o tempo limite da consulta e retornar 500. Recomendamos varrer em janelas de até 15 dias, paginando dentro de cada janela. Se precisar do bloco lastVersion, use limit entre 5 e 10 para não estourar o limite de tamanho da resposta (ver 502).

Security
InternalAuth
Query
dateStartstringrequired

Início do período, no formato AAAA-MM-DD

Example:dateStart=2026-07-01
dateEndstringrequired

Fim do período, no formato AAAA-MM-DD. Não pode ser anterior a dateStart e a janela não pode exceder 366 dias

Example:dateEnd=2026-07-15
dateFieldstring

Qual data o filtro usa — created (protocolo), updated (última movimentação) ou finished (encerramento)

Default:"created"
Enum:"created""updated""finished"
Example:dateField=updated
typeIdstring

Filtra por assunto. É o ObjectId do formulário, obtido em GET /hub-api/type/find

Example:typeId=60df5787146b5035772c5bcd
includestring

Blocos pesados a incluir, separados por vírgula. Aceita timeline e lastVersion. Omitir o parâmetro traz ambos; enviá-lo vazio (include=) não traz nenhum

Example:include=timeline
cursorstring

Cursor da próxima página, obtido no nextCursor da resposta anterior

Example:cursor=6a574d64c801b5200269cea0
limitinteger, [ 1 .. 50 ]

Itens por página, de 1 a 50

Default:20
Example:limit=50
cityIdinteger

Cidade a consultar. Ignorado nas chaves de cidade, que sempre leem a própria cidade

Example:cityId=145
GET
/hub-api/process/list
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/process/list?dateStart=2026-07-01&dateEnd=2026-07-15&dateField=updated&typeId=60df5787146b5035772c5bcd&include=timeline&cursor=6a574d64c801b5200269cea0&limit=50&cityId=145' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Página de processos da cidade

Bodyapplication/json
itemsArray of objects

Processos da página, ordenados de forma estável para a paginação

nextCursorstring or null

Cursor da próxima página, ou null quando não há mais páginas

Example:"6a574d64c801b5200269cea0"
Response
{
  "items": [
    { … },
    { … }
  ],
  "nextCursor": "6a574d6ec801b5200269cecc"
}