Documentação API

Arthur • 03/07/2025

Navegação Interna

A API ADVBOX oferece um conjunto abrangente de rotas para integração com sistemas externos, permitindo automação e otimização de processos em escritórios de advocacia. Para utilizar a API de forma eficiente:

Documentação: Consulte este guia e a documentação oficial para referência
Autenticação: Sempre inclua o token Bearer no cabeçalho de autorização
Limites de requisição: Respeite os limites para evitar bloqueios temporários
Tratamento de erros: Implemente tratamento adequado para os códigos de erro retornados
Formato de resposta: Todas as rotas retornam dados em formato JSON

Para suporte técnico ou dúvidas sobre a API, entre em contato com a equipe de suporte da ADVBOX.

Autenticação

Utilizamos um método de validação das requisições por Bearer token, que é obtido diretamente em sua conta ADVBOX no menu Configurações > Integrações e API.

Base URL

https://app.advbox.com.br/api/v1

Exemplo de cURL para consulta de clientes

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Rate Limit

Limites por Método HTTP:

GET 30 requisições por minuto

POST 100 requisições por dia para cada rota

PUT 500 requisições por dia para cada rota

Documentação

A documentação completa pode ser acessada diretamente pelo Swagger Hub da ADVBOX.

Rotas Disponíveis

Gerenciamento de Clientes

Listar Clientes

GET /customers

Descrição: Ideal para buscar clientes cadastrados no sistema, permitindo filtragem por diferentes critérios. Útil para verificar se um cliente já existe antes de criar um novo registro ou para localizar informações de contato rapidamente.

Funcionalidade: Recupera uma lista de clientes com base em filtros como nome ou CPF/CNPJ.

Parâmetros de Query

Parâmetro	Tipo	Descrição
name	string (query)	Nome do cliente ou parte dele. Você pode usar um nome completo ou termo de busca parcial (ex: nome ou sobrenome).
phone	string (query)	Telefone do cliente (ex: 48991234567 ou (48)99123-4567).
identification	string (query)	Identificação do cliente (CPF/CNPJ).
limit	integer (query)	Número de itens na resposta, entre 1 e 1000.
offset	integer (query)	Número de itens a pular antes de iniciar a resposta (paginação).

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers?name=John&limit=10' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Importante: Sempre substitua {bearer_token} pelo seu token real obtido nas configurações da sua conta ADVBOX.

Criar Novo Cliente

POST /customers

Descrição: Permite criar um novo cliente no sistema. Útil para automatizar o processo de cadastro de clientes a partir de sistemas externos ou formulários web.

Funcionalidade: Cria um novo registro de cliente com as informações fornecidas.

Parâmetros do Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
users_id	integer	Sim	ID do usuário que está criando o cliente.
customers_origins_id	integer	Sim	ID da origem do cliente.
name	string	Sim	Nome completo do cliente.
email	string	Não	Endereço de e-mail do cliente.

Exemplo de Requisição

curl -X 'POST' \
'https://app.advbox.com.br/api/v1/customers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {bearer_token}' \
-H 'Content-Type: application/json' \
-d '{
"users_id": 12345,
"customers_origins_id": 67890,
"name": "John Doe",
"email": "john.doe@example.com"
}'

Resposta de Sucesso

[
{
"success": true,
"customer_id": 128712976
}
]

Obter Cliente por ID

GET /customers/{id}

Descrição: Recupera os dados detalhados de um cliente específico com base no seu ID único. Útil para obter informações completas de um cliente após identificá-lo em uma listagem ou para verificar dados atualizados.

Funcionalidade: Retorna todos os dados cadastrais do cliente especificado pelo ID.

Parâmetros de Path

Parâmetro	Tipo	Descrição
id	integer (path)	ID único do cliente a ser consultado.

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers/123' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Aniversários de Clientes

GET /customers/birthdays

Descrição: Recupera uma lista de clientes que fazem aniversário no mês atual. Útil para campanhas de marketing, felicitações automáticas ou relatórios de CRM.

Funcionalidade: Retorna uma lista de clientes com aniversários no mês atual, com opções de paginação.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de registros a serem retornados (entre 1 e 1000).
offset	integer	Não	Número de registros a serem ignorados antes de iniciar a resposta (para paginação).

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers/birthdays?limit=20&offset=0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Gerenciamento de Processos Judiciais

Listar Processos

GET /lawsuits

Descrição: Recupera uma lista de processos judiciais cadastrados no sistema. Permite filtrar por diversos critérios e paginar os resultados.

Funcionalidade: Retorna uma lista de processos judiciais com informações resumidas.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Não	Nome do processo ou parte dele.
process_number	string	Não	Número do processo judicial.
protocol_number	string	Não	Número de protocolo do processo.
customer_id	integer	Não	ID do cliente associado ao processo.
limit	integer	Não	Número máximo de registros a serem retornados (entre 1 e 100).
offset	integer	Não	Número de registros a serem ignorados antes de iniciar a resposta (para paginação).
group	string	Não	Filtrar processos por nome ou ID do grupo.
type	string	Não	Filtrar processos por nome ou ID do tipo.
responsible	string	Não	Filtrar processos por nome ou ID do responsável.
stage	string	Não	Filtrar processos por nome ou ID da fase (Judicial, Recursal...).
step	string	Não	Filtrar processos por nome ou ID da etapa (Aguardando retorno, Petição inicial...).

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/lawsuits?customer_id=123&limit=10' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Criar Novo Processo

POST /lawsuits

Descrição: Permite criar um novo processo judicial no sistema. Útil para automatizar o cadastro de processos a partir de sistemas externos ou integrações com tribunais.

Funcionalidade: Cria um novo registro de processo judicial com as informações fornecidas.

Parâmetros de Body

Parâmetro	Tipo	Obrigatório	Descrição
users_id	string	Sim	ID do usuário que está criando o processo.
customers_id	array[integer]	Sim	Lista de IDs de clientes associados ao processo.
stages_id	string	Sim	ID da fase do processo.
type_lawsuits_id	string	Sim	ID do tipo de processo.
process_number	string	Não	Número do processo judicial.
protocol_number	string	Não	Número de protocolo do processo.
folder	string	Não	Nome da pasta para o processo.
date	string	Não	Data do processo no formato DD/MM/YYYY.
notes	string	Não	Informações detalhadas sobre o processo, incluindo histórico, notas importantes e contexto adicional para referência futura.

Exemplo de Requisição

curl -X 'POST' \
'https://app.advbox.com.br/api/v1/lawsuits' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {bearer_token}' \
-H 'Content-Type: application/json' \
-d '{
"users_id": "12345",
"customers_id": [67890, 54321],
"stages_id": "98765",
"type_lawsuits_id": "43210",
"protocol_number": "PROC123456",
"folder": "Client A",
"date": "29/05/2025",
"notes": "Processo iniciado para cliente corporativo referente a disputa contratual",
"process_number": "0123456-78.2025.8.26.0100"
}'

Resposta de Sucesso

[
{
"success": true,
"lawsuit_id": 128712976
}
]

Obter Processo por ID

GET /lawsuits/{id}

Descrição: Recupera os dados detalhados de um processo judicial específico com base no seu ID único. Útil para obter informações completas de um processo após identificá-lo em uma listagem.

Funcionalidade: Retorna todos os dados cadastrais do processo especificado pelo ID.

Parâmetros de Path

Parâmetro	Tipo	Descrição
id	integer (path)	ID único do processo a ser consultado.

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/lawsuits/123' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Resposta de Sucesso

{
"id": 123,
"users_id": "12345",
"customers_id": [67890, 54321],
"stages_id": "98765",
"type_lawsuits_id": "43210",
"process_number": "0123456-78.2025.8.26.0100",
"protocol_number": "PROC123456",
"folder": "Client A",
"date": "29/05/2025",
"notes": "Processo iniciado para cliente corporativo referente a disputa contratual",
"created_at": "2025-05-29T10:30:45Z",
"updated_at": "2025-05-29T10:30:45Z"
}

Atualizar Processo

PUT /lawsuits/{id}

Descrição: Permite atualizar os dados de um processo judicial existente. Útil para manter as informações do processo sempre atualizadas conforme o andamento judicial.

Funcionalidade: Atualiza os dados do processo especificado pelo ID.

Parâmetros de Path

Parâmetro	Tipo	Descrição
id	integer (path)	ID único do processo a ser atualizado.

Parâmetros do Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
users_id	string	Sim	ID do usuário atualizando o processo.
stages_id	string	Sim	ID da etapa do processo.
type_lawsuits_id	string	Sim	ID do tipo de processo.
process_number	string	Não	Número do processo.
protocol_number	string	Não	Número do protocolo.
folder	string	Não	Nome da pasta para o processo.
date	string	Não	Data do processo no formato DD/MM/YYYY.
notes	string	Não	Informações detalhadas sobre o processo, incluindo histórico, notas importantes e contexto adicional para referência futura.

Exemplo de Requisição

curl -X 'PUT' \
'https://app.advbox.com.br/api/v1/lawsuits/123' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer your_token_here' \
-H 'Content-Type: application/json' \
-d '{
"stages_id": "98765"
}'

Resposta de Sucesso

[
{
"success": true,
"lawsuits_id": "2468677"
}
]

Gerenciamento de Movimentações

Listar Tarefas de Processo

GET /history/{lawsuit_id}/

Descrição: Lista as tarefas associadas a um processo judicial, com filtragem opcional por status (pendente ou concluído).

Funcionalidade: Retorna uma lista das tarefas mais recentes relacionadas ao processo especificado.

Parâmetros de Path

Parâmetro	Tipo	Descrição
lawsuit_id	integer (path)	ID do processo judicial.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
status	string (enum)	Não	Status da tarefa (pending ou completed).
limit	integer	Não	Número de itens na resposta, entre 1 e 100.
offset	integer	Não	Número de itens a pular antes de iniciar a resposta (paginação).

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/history/123?status=pending' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Listar Movimentações de Processo

GET /movements/{lawsuit_id}

Descrição: Lista as movimentações associadas a um processo judicial específico.

Funcionalidade: Retorna uma lista de movimentações processuais associadas ao processo especificado.

Parâmetros de Path

Parâmetro	Tipo	Descrição
lawsuit_id	integer (path)	O ID único do processo judicial.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
origin	string (enum)	Não	Filtrar movimentações por origem (TRIBUNAL ou MANUAL).

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/movements/123?origin=TRIBUNAL' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Resposta de Sucesso

[
{
"movement_id": 456,
"date": "2025-01-31",
"description": "Audiência marcada para 15/02/2025",
"type": "Audiência"
}
]

Criar Movimentação Manual

POST /lawsuits/movement

Descrição: Cria uma nova movimentação manual para um processo judicial.

Funcionalidade: Permite registrar manualmente uma nova movimentação processual associada a um processo específico.

Parâmetros do Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
lawsuit_id	integer	Sim	ID do processo
date	string	Sim	Data do andamento no formato DD/MM/YYYY
description	string	Sim	Descrição do andamento

Exemplo de Requisição

curl -X 'POST' \
'https://app.advbox.com.br/api/v1/lawsuits/movement' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer your_token_here' \
-H 'Content-Type: application/json' \
-d '{ "lawsuit_id": 123, "date": "25/06/2025", "description": "Audiência de conciliação agendada" }'

Resposta de Sucesso

{
"success": true,
"movement_id": 789
}

Esta documentação fornece as informações essenciais para começar a usar a API ADVBOX. Para detalhes técnicos completos, consulte a documentação oficial no Swagger Hub.

Gerenciamento de Tarefas

Criar Nova Tarefa

POST /posts

Descrição: Cria uma nova tarefa no sistema.

Funcionalidade: Permite criar uma tarefa associada a um processo judicial específico.

Parâmetros do Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
from	string	Sim	ID do usuário que está criando a tarefa
guests	array	Sim	IDs dos usuários convidados
tasks_id	string	Sim	ID da tarefa
lawsuits_id	string	Sim	ID do processo judicial
comments	string	Não	Comentários sobre a tarefa
start_date	string	Sim	Data de início (formato: DD/MM/YYYY)
start_time	string	Não	Hora de início (formato: HH:MM)
end_date	string	Não	Data de término (formato: DD/MM/YYYY)
end_time	string	Não	Hora de término (formato: HH:MM)
date_deadline	string	Não	Data limite (formato: DD/MM/YYYY)
local	string	Não	Local da tarefa
urgent	boolean	Não	Indica se a tarefa é urgente
important	boolean	Não	Indica se a tarefa é importante
display_schedule	boolean	Não	Indica se a tarefa deve ser exibida no calendário

Exemplo de Requisição

curl -X 'POST' \
'https://app.advbox.com.br/api/v1/posts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer your_token_here' \
-H 'Content-Type: application/json' \
-d '{ "from": "12345", "guests": [67890, 54321], "tasks_id": "98765", "lawsuits_id": "43210", "comments": "Preparar documentação para audiência preliminar e revisar argumentos principais", "start_date": "29/05/2025", "start_time": "14:30", "end_date": "29/05/2025", "end_time": "16:00", "date_deadline": "05/06/2025", "local": "Sala de reuniões - 3º andar", "urgent": true, "important": true, "display_schedule": true }'

Listar Últimas Movimentações

GET /last_movements

Descrição: Recupera as últimas movimentações de todos os processos judiciais.

Funcionalidade: Permite visualizar as movimentações mais recentes de todos os processos em um único endpoint.

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/last_movements' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Resposta de Sucesso

[
{
"id": 1,
"lawsuit_id": 123,
"date": "2025-01-31",
"description": "Movement description",
"type": "Movement type"
},
{
"id": 2,
"lawsuit_id": 456,
"date": "2025-01-30",
"description": "Another movement description",
"type": "Another movement type"
}
]

Configurações

Obter Configurações da Conta

GET /settings

Descrição: Recupera as configurações e configuração da conta.

Funcionalidade: Retorna os detalhes de configuração da conta do usuário.

Parâmetros

Parâmetro	Descrição
Nenhum parâmetro necessário

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/settings' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Exemplo de Resposta (200 OK)

{
"account": {
...
}
}

Usuários

Obter Recompensas do Usuário

GET /users/rewards

Descrição: Recupera as recompensas do usuário para uma data específica.

Funcionalidade: Retorna informações sobre as recompensas obtidas pelo usuário em uma data específica.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
date	string (date)	Sim	Data no formato yyyy-mm-dd

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/users/rewards?date=2025-05-07' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Publicações

Obter Publicações por ID do Processo

GET /publications/{lawsuit_id}

Descrição: Recupera todas as publicações associadas a um processo específico.

Funcionalidade: Retorna uma lista de publicações relacionadas ao processo judicial especificado pelo ID.

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
lawsuit_id	integer (path)	Sim	ID do processo judicial

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
limit	integer (query)	Não	Número de itens na resposta, entre 1 e 100. Valor padrão: 10
page	integer (query)	Não	Número da página para paginação. Valor padrão: 1

Exemplo de Requisição

curl -X 'GET' \
'https://app.advbox.com.br/api/v1/publications/123' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your_token_here'

Códigos de Resposta HTTP

Código	Descrição
200 OK	Requisição bem-sucedida. A resposta contém os dados solicitados.
400 Bad Request	Requisição inválida. Verifique os parâmetros enviados.
401 Unauthorized	Falha na autenticação. Verifique seu token de acesso.
403 Forbidden	Sem permissão para acessar este recurso.
404 Not Found	Recurso não encontrado.
429 Too Many Requests	Limite de requisições excedido. Aguarde antes de tentar novamente.
500 Internal Server Error	Erro interno no servidor. Entre em contato com o suporte.