Obtenha uma lista de processos

Retorna uma lista de processos com opções avançadas de filtro e paginação.

Como funcionam os filtros:

Múltiplos filtros são combinados com AND (interseção)
Filtros de texto são case-insensitive
Alguns campos aceitam busca parcial (name, group, type, responsible, stage, step, notes)
Outros requerem valor exato (customer_id, process_number, protocol_number, folder, identification)
Filtros de data funcionam como range (use _start e _end juntos)

A resposta inclui totalCount (total de registros), data (array de processos) e informações de paginação (limit e offset).

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

name?string

[Optional] Busca parcial no nome dos contatos associados ao processo.

customer_id?integer

[Optional] ID exato do contato associado ao processo.

identification?string

[Optional] CPF ou CNPJ do contato associado ao processo. Aceita formatação com pontos e traços.

process_number?string

[Optional] Número exato do processo.

protocol_number?string

[Optional] Número exato do protocolo do processo.

folder?string

[Optional] Nome exato da pasta do processo.

notes?string

[Optional] Busca parcial nas anotações ou comentários do processo.

group?string

[Optional] Busca parcial no grupo do processo. Case-insensitive.

type?string

[Optional] Busca parcial no tipo do processo.

responsible?string

[Optional] Busca parcial no nome do responsável.

stage?string

[Optional] Busca parcial no nome da fase processual ou ID numérico.

step?string

[Optional] Busca parcial no nome do passo.

process_date_start?string

[Optional] Data inicial para filtrar por data do processo (formato: AAAA-MM-DD).

Formatdate

process_date_end?string

[Optional] Data final para filtrar por data do processo (formato: AAAA-MM-DD).

Formatdate

status_closure_start?string

[Optional] Data de início da filtragem dos processos por data de encerramento do status (formato: AAAA-MM-DD).

Formatdate

status_closure_end?string

[Optional] Data final para filtrar processos por data de encerramento do status (formato: AAAA-MM-DD).

Formatdate

exit_production_start?string

[Optional] Data inicial para filtrar processos por data de saída da produção (formato: AAAA-MM-DD).

Formatdate

exit_production_end?string

[Optional] Data final para filtrar processos por data de saída da produção (formato: AAAA-MM-DD).

Formatdate

exit_execution_start?string

[Optional] Data inicial para filtrar processos por data de execução da sentença (formato: AAAA-MM-DD).

Formatdate

exit_execution_end?string

[Optional] Data final para filtrar processos por data de execução de saída (formato: AAAA-MM-DD).

Formatdate

created_start?string

[Optional] Data inicial para filtrar processos por data de criação (formato: AAAA-MM-DD).

Formatdate

created_end?string

[Optional] Data final para filtrar processos por data de criação (formato: AAAA-MM-DD).

Formatdate

limit?integer

[Optional] Número de registros a retornar por página (padrão: 1000, recomendado: até 100).

Default1000

Range1 <= value <= 100

offset?integer

[Optional] Número de registros a pular para paginação (padrão: 0).

Default0

Range0 <= value

Response Body

`application/json`

curl -X GET "https://app.advbox.com.br/api/v1/lawsuits"

{
  "totalCount": 150,
  "limit": 10,
  "offset": 0,
  "data": [
    {
      "id": 12345,
      "process_number": "0001234-56.2024.8.26.0100",
      "protocol_number": "123456789",
      "folder": "Pasta A",
      "process_date": "2024-01-15",
      "fees_expec": 5000,
      "fees_money": 3000,
      "contingency": 2000,
      "type_lawsuit_id": 100,
      "type": "AÇÃO TRABALHISTA",
      "group_id": 200,
      "group": "TRABALHISTA",
      "created_at": "2024-01-15 10:30:00",
      "status_closure": "2024-06-20 15:45:00",
      "exit_production": null,
      "exit_execution": null,
      "responsible_id": 300,
      "responsible": "João Silva",
      "stages_id": 400,
      "stage": "FASE INSTRUTÓRIA",
      "steps_id": 500,
      "step": "JUDICIAL",
      "notes": "Processo em andamento normal",
      "customers": [
        {
          "customer_id": 600,
          "name": "Maria Santos",
          "identification": "123.456.789-00",
          "origin": "INDICAÇÃO"
        }
      ]
    }
  ],
  "query": {
    "limit": "10"
  }
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

Empty

Obtenha uma lista de processos

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

404

`application/json`

`application/json`

`application/json`