15 - API Pública Sisjud

15 api pública sisjud manual – api pública sisjud v1 este manual descreve a api pública do sisjud para integração de sistemas externos (erps, portais, automações) a api é autenticada por chave (api key) e expõe os principais recursos do escritório clientes, casos, tarefas, boletos, prospecção, cobrança e negociações índice visão geral autenticação url base e formato recursos e endpoints 4 1 clientes 4 1 1 vínculos entre clientes (subclientes) 4 2 usuários 4 3 casos 4 4 tarefas 4 5 boletos 4 6 prospecção 4 7 cobrança 4 8 negociações exemplos por recurso códigos de resposta e erros postman / insomnia 1\ visão geral item valor versão v1 base url https //app sisjud com br/api/v1/ autenticação header x api key ou authorization bearer \<chave> formato json (request e response) cors habilitado para qualquer origem a chave é vinculada ao escritório todas as requisições retornam ou alteram apenas dados desse escritório como obter a chave no sisjud, acesse configurações (menu do escritório) → aba api pública → criar chave informe um nome (ex "sistema erp") e copie a chave exibida uma única vez guarde em local seguro; não é possível recuperá la depois 2\ autenticação envie a chave em um dos formatos abaixo opção a – header x api key get /api/v1/clientes http/1 1 host app sisjud com br x api key sk live xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx content type application/json opção b – authorization bearer get /api/v1/clientes http/1 1 host app sisjud com br authorization bearer sk live xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx content type application/json chave inválida ou inativa a api responde com http 401 e corpo { "error" "unauthorized", "message" "chave inválida ou inativa " } 3\ url base e formato base https //app sisjud com br/api/v1/ + recurso no path exemplos forma exemplo path get /api/v1/clientes query (sempre válido) get /api/v1/index php?url=clientes sub recursos e ids alguns recursos usam segundo segmento /api/v1/cobranca/boletos /api/v1/cobranca/calculos para um único item /api/v1/casos/123 ou ?url=casos/123 ou ?url=casos\&id=123 body em post/put, envie json com content type application/json no recurso prospeccao (leads/kanban), operações post aceitam também application/x www form urlencoded ; para criar lead ( op=create ), o uso de form urlencoded é recomendado 4\ recursos e endpoints recurso métodos descrição clientes get, post, put, delete crud de clientes do escritório usuarios get, post, put, delete crud de usuários do escritório casos get, post, put, delete crud de casos tarefas get, post, put, delete crud de tarefas boletos get, post, put, delete crud de boletos prospeccao get, post leads e kanban (parâmetro op ) cobranca get listagem de boletos e cálculos negociacoes get listagem de parcelamentos e detalhe com parcelas 4 1 clientes método url / parâmetros descrição get /api/v1/clientes lista todos os clientes do escritório get /api/v1/clientes?id=123 cliente por id post /api/v1/clientes cria cliente put /api/v1/clientes atualiza cliente delete /api/v1/clientes remove cliente campos principais (post/put) campo obrigatório descrição nomecompleto sim nome completo do cliente cpf sim 11 dígitos (pf) ou 14 dígitos (pj) email não e mail celular não celular com ddd nomefantasia não nome fantasia (pj) cnpj não cnpj (14 dígitos) endereco não logradouro bairro não bairro cidade não cidade estado não estado (uf) cep não cep telresidencial não telefone residencial telcomercial não telefone comercial 4 1 1 vínculos entre clientes (subclientes) o sisjud permite vincular clientes como subclientes de um cliente principal (relação n\ n) subclientes possuem cadastro completo e podem participar dos mesmos casos, mas não são codevedores — apenas o cliente principal responde nas cobranças tabelas de vínculo tabela descrição cliente vinculos idcliente principal , idcliente vinculado , tipo caso clientes idcaso , idcliente , tipo ('principal' ou 'subcliente') regras de negócio um subcliente pode estar vinculado a múltiplos clientes principais casos idcliente permanece como referência ao principal (retrocompatibilidade total) ao listar casos de um cliente, o campo vinculo tipo indica 'principal' ou 'subcliente' endpoints internos (autenticados por sessão, não por api key) método url descrição get /api/clientes vinculos listar php?idcliente=x lista subclientes vinculados a x + principais de x post /api/clientes vinculo adicionar php cria vínculo (body idcliente principal , idcliente vinculado ) post /api/clientes vinculo remover php remove vínculo (body idcliente principal , idcliente vinculado ) resposta do get /api/clientes vinculos listar php { "success" true, "data" \[ { "id" 2, "nomecompleto" "maria souza", "cpf" "12345678901", "tipo" "subcliente", "criado em" "2026 07 05 18 14 13" } ], "principais" \[ { "id" 1, "nomecompleto" "joão silva" } ] } 4 2 usuários método url descrição get /api/v1/usuarios lista usuários do escritório post /api/v1/usuarios cria usuário put /api/v1/usuarios atualiza usuário delete /api/v1/usuarios remove usuário campos nome, email, senha, telefone, cpf, cargo, nivel acesso, escritorio 4 3 casos método url / parâmetros descrição get /api/v1/casos lista casos do escritório get /api/v1/casos?cliente id=5 casos de um cliente get /api/v1/casos/123 ou ?id=123 um caso por id post /api/v1/casos cria caso put /api/v1/casos atualiza caso (id no body/path) delete /api/v1/casos remove caso campos principais campo descrição idcliente id do cliente principal idescritorio id do escritório tipocaso 1=judicial, 2=administrativo, 3=cobrança parteadversa nome da parte adversa / devedor numcnj número cnj (20 dígitos) numprocesso número do processo administrativo posicaocliente 1=autor, 2=réu areaatuacao área de atuação assunto assunto do caso localtramite local de trâmite comarca comarca valorcausa valor da causa datadistribuicao data de distribuição observacao observações enderecodev endereço do devedor telfixodev telefone fixo do devedor telceldev celular do devedor cpf cpf/cnpj do devedor vinculo tipo 'principal' ou 'subcliente' (presente ao listar casos filtrando por cliente) ao listar casos de um cliente que participa como subcliente (via caso clientes ), o campo vinculo tipo retorna 'subcliente' para distinguir dos casos onde ele é o principal 4 4 tarefas método url / parâmetros descrição get /api/v1/tarefas lista tarefas do escritório get /api/v1/tarefas?id=123 uma tarefa por id post /api/v1/tarefas cria tarefa put /api/v1/tarefas atualiza tarefa delete /api/v1/tarefas remove tarefa campos típicos idcliente, idescritorio, titulo, descricao, prazo, status 4 5 boletos método url / parâmetros descrição get /api/v1/boletos lista boletos get /api/v1/boletos?id=123 boleto por id post /api/v1/boletos cria boleto put /api/v1/boletos atualiza boleto delete /api/v1/boletos remove boleto 4 6 prospecção todas as chamadas usam o parâmetro op (get ou post) base /api/v1/prospeccao ou /api/v1/prospecao op método descrição list get lista leads (filtros status, responsavel id, busca) get get detalhe de um lead ( id ) create post cria lead (nome, telefone, email, cpf cnpj, etc ) update post atualiza lead (id + campos) kanban colunas get lista colunas do kanban kanban list get colunas e cards do kanban (filtro busca) kanban move post move card (id, coluna) kanban coluna save post cria/atualiza coluna (id, nome, slug, ordem) kanban colunas ordem post atualiza ordem das colunas (ordem array de ids) kanban coluna apagar post remove coluna (id) kanban gatilhos get lista gatilhos (id coluna opcional) kanban gatilho save post cria/atualiza gatilho kanban gatilho apagar post remove gatilho (id) tags list get lista tags do escritório tags create post cria tag (nome, cor) tags update post atualiza tag (id, nome, cor) tags delete post remove tag (id) lead tags update post adiciona/remove tag do lead (idlead, idtag, action) comentarios list get comentários de um lead (id) comentario add post adiciona comentário (id, comentario, mencoes) comentario apagar post remove comentário (id do comentário) anexos list get lista anexos do lead (id) anexo upload post envia anexo (id do lead + arquivo em multipart) anexo apagar post remove anexo (id do anexo) busca cliente get busca cliente por cpf/cnpj (query cpf cnpj) lead converter completo post converte lead em cliente + caso (lead id, id gatilho + dados) criar lead ( op=create ) envie op=create na query ou no body campos aceitos nome , telefone , email , cpf cnpj (11 ou 14 dígitos), origem , observacoes , responsavel id , status (slug da coluna; se omitido, usa a primeira coluna do kanban) resposta de sucesso { "success" true, "message" "lead criado", "id" \<id>, "idcliente vinculado" \<id ou null> } se cpf cnpj for enviado e já existir cliente com esse cpf/cnpj no escritório, o lead é criado já vinculado a esse cliente 4 7 cobrança apenas get sub recurso no path ou em url sub recurso url parâmetros (opcional) descrição boletos /api/v1/cobranca ou /api/v1/cobranca/boletos idcliente, idcaso, pago (0/1), limit lista boletos (boletos dados) cálculos /api/v1/cobranca/calculos idcaso lista cálculos do escritório exemplo get /api/v1/cobranca/boletos?idcaso=5\&pago=0 4 8 negociações apenas get lista parcelamentos ou detalhe de um parcelamento (com parcelas) chamada url / parâmetros descrição listar /api/v1/negociacoes?idcaso=x lista parcelamentos de um caso detalhe /api/v1/negociacoes?id=123 ou path /negociacoes/123 parcelamento com array de parcelas exemplos get /api/v1/negociacoes?idcaso=10 get /api/v1/negociacoes?id=45 5\ exemplos por recurso listar clientes get /api/v1/clientes http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/json criar cliente post /api/v1/clientes http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/json { "nomecompleto" "maria silva", "cpf" "12345678901", "email" "maria\@email com", "celular" "11999998888" } listar leads (prospecção) get /api/v1/prospeccao?op=list http/1 1 host app sisjud com br x api key sk live sua chave aqui kanban da prospecção get /api/v1/prospeccao?op=kanban list http/1 1 host app sisjud com br x api key sk live sua chave aqui criar lead (prospecção) post /api/v1/prospeccao?op=create http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/x www form urlencoded nome=joão silva\&telefone=11999998888\&email=joao\@email com\&cpf cnpj=12345678901\&origem=site\&observacoes=lead vindo do formulário resposta de sucesso (200) { "success" true, "message" "lead criado", "id" 42, "idcliente vinculado" null } cobrança – boletos em aberto get /api/v1/cobranca/boletos?pago=0 http/1 1 host app sisjud com br x api key sk live sua chave aqui negociações de um caso get /api/v1/negociacoes?idcaso=12 http/1 1 host app sisjud com br x api key sk live sua chave aqui 6\ códigos de resposta e erros código significado 200 sucesso (get, put, delete ou post com retorno de dados) 201 recurso criado (post) 400 dados inválidos ou incompletos 401 chave ausente, inválida ou inativa 404 recurso ou endpoint não encontrado 405 método não permitido para o recurso 500 erro interno do servidor respostas de erro em json costumam seguir o formato { "error" "unauthorized", "message" "chave inválida ou inativa " } ou { "message" "os campos 'nomecompleto' e 'cpf' são obrigatórios " } 7\ postman / insomnia foi disponibilizada uma postman collection com todos os endpoints da api v1 e variáveis para url base e chave arquivo api/postman/sisjud api v1 postman collection json uso no postman import → upload files → selecione o json variáveis da collection base url ex https //app sisjud com br (sem barra no final) api key sua chave (ex sk live ) a collection inclui pastas por recurso (clientes, casos, tarefas, boletos, usuários, prospecção, cobrança, negociações) e requisições de exemplo ajuste base url e api key no nível da collection ou em environment para usar em todos os requests manual sisjud – api pública v1 atualizado em julho 2026