Documentação da API · catálogo capturado
Operações visÃÂveis na documentação. Esta cópia não executa requisições, não autentica e não substitui a especificação do fornecedor.
| GET | /v1/clientes | Listar clientes |
| POST | /v1/clientes | Criar um novo cliente |
| GET | /v1/clientes/{id} | Buscar cliente por ID |
| PATCH | /v1/clientes/{id} | Atualizar cliente |
| DELETE | /v1/clientes/{id} | Deletar cliente |
| GET | /v1/clientes/{id}/etiquetas | Um cliente  listar suas etiquetas |
| POST | /v1/clientes/{id}/etiquetas | Um cliente  adicionar etiquetas |
| DELETE | /v1/clientes/{id}/etiquetas | Um cliente  remover todas as etiquetas |
| DELETE | /v1/clientes/{id}/etiquetas/{tag_id} | Um cliente  remover uma etiqueta |
| GET | /v1/etiquetas/clientes | Catálogo do escritório  listar etiquetas |
| POST | /v1/etiquetas/clientes | Catálogo do escritório  criar etiqueta |
| GET | /v1/etiquetas/clientes/{id} | Catálogo do escritório  obter etiqueta |
| PATCH | /v1/etiquetas/clientes/{id} | Catálogo do escritório  atualizar etiqueta |
| DELETE | /v1/etiquetas/clientes/{id} | Catálogo do escritório  excluir etiqueta (sai de todos os clientes) |
| GET | /v1/usuarios | Listar usuários do escritório |
| POST | /v1/usuarios | Criar um novo usuário |
| GET | /v1/usuarios/{id} | Obter usuário por ID |
| PATCH | /v1/usuarios/{id} | Atualizar usuário |
| DELETE | /v1/usuarios/{id} | Remover usuário da organização |
| GET | /v1/atividades | Listar atividades |
| POST | /v1/atividades | Criar uma nova atividade |
| GET | /v1/atividades/{id} | Buscar atividade por ID |
| PATCH | /v1/atividades/{id} | Atualizar atividade |
| DELETE | /v1/atividades/{id} | Deletar atividade |
| GET | /v1/etiquetas/atividades | Catálogo de etiquetas de atividade  listar |
| POST | /v1/etiquetas/atividades | Catálogo de etiquetas de atividade  criar |
| GET | /v1/etiquetas/atividades/{id} | Catálogo de etiquetas de atividade  obter |
| PATCH | /v1/etiquetas/atividades/{id} | Catálogo de etiquetas de atividade  atualizar |
| DELETE | /v1/etiquetas/atividades/{id} | Catálogo de etiquetas de atividade  excluir (sai de todas as atividades) |
| GET | /v1/atividades/{id}/etiquetas | Uma atividade  listar suas etiquetas |
| POST | /v1/atividades/{id}/etiquetas | Uma atividade  adicionar etiquetas |
| DELETE | /v1/atividades/{id}/etiquetas | Uma atividade  remover todas as etiquetas |
| DELETE | /v1/atividades/{id}/etiquetas/{tag_id} | Uma atividade  remover uma etiqueta |
| GET | /v1/processos | Listar processos |
| POST | /v1/processos | Criar processo |
| GET | /v1/processos/{id} | Buscar processo por ID |
| PATCH | /v1/processos/{id} | Atualizar processo |
| DELETE | /v1/processos/{id} | Excluir processo |
| GET | /v1/processos/{id}/partes | Listar partes do processo |
| PATCH | /v1/processos/{id}/partes/{parte_id} | Atualizar polo de uma parte |
| PATCH | /v1/processos/{id}/partes/{parte_id}/vincular | Vincular parte a um cliente |
| DELETE | /v1/processos/{id}/partes/{parte_id}/vincular | Desvincular parte de um cliente |
| GET | /v1/processos/{id}/movimentacoes | Listar movimentações do processo |
| GET | /v1/processos/{id}/documentos | Listar documentos do processo |
| GET | /v1/processos/{id}/documentos/{documento_id}/conteudo | Ler o texto de um documento do processo |
| GET | /v1/processos/{id}/documentos/{documento_id}/arquivo | Baixar o arquivo original de um documento do processo |
| GET | /v1/processos/{id}/etiquetas | Um processo  listar suas etiquetas |
| POST | /v1/processos/{id}/etiquetas | Um processo  adicionar etiquetas |
| DELETE | /v1/processos/{id}/etiquetas | Um processo  remover todas as etiquetas |
| DELETE | /v1/processos/{id}/etiquetas/{tag_id} | Um processo  remover uma etiqueta |
| GET | /v1/notas | Listar notas |
| POST | /v1/notas | Criar uma nova nota |
| GET | /v1/notas/{id} | Buscar nota por ID |
| PATCH | /v1/notas/{id} | Atualizar nota |
| DELETE | /v1/notas/{id} | Deletar nota |
| GET | /v1/publicacoes | Listar publicações |
| POST | /v1/clientes/{id}/emails/address | Criar e-mail exclusivo para cliente |
| POST | /v1/documentos/geradores/lotes-de-documentos | Gerar o lote de documentos do Kit Previdenciário de um cliente para assinatura |
| GET | /v1/documentos | Listar e pesquisar documentos e modelos |
| POST | /v1/documentos | Criar um documento |
| GET | /v1/documentos/{id} | Ler um documento ou um modelo |
| PATCH | /v1/documentos/{id} | Alterar um documento ou um modelo |
| DELETE | /v1/documentos/{id} | Mover um documento para a lixeira |
| POST | /v1/documentos/{id}/transformacoes-em-modelo | Transformar em modelo com a TramitaIA |
| GET | /v1/documentos/{id}/transformacoes-em-modelo/{transformacao_id} | Consultar uma transformação em modelo |
| GET | /v1/clientes/{id}/arquivos | Listar arquivos de um cliente |
| GET | /v1/arquivos | Listar arquivos da organização |
| POST | /v1/arquivos | Registrar um arquivo enviado pelo envio direto |
| POST | /v1/arquivos/envios-diretos | Criar o envio direto de um arquivo |
| GET | /v1/arquivos/{iid} | Download de arquivo |
| GET | /v1/arquivos/{iid}/metadata | Metadados de um arquivo |
| GET | /v1/uploads/{iid} | Download de anexo (legado) |
| GET | /v1/webhooks/endpoints | Listar endpoints de webhook |
| POST | /v1/webhooks/endpoints | Criar endpoint de webhook |
| GET | /v1/webhooks/endpoints/{id} | Buscar endpoint de webhook por ID |
| PATCH | /v1/webhooks/endpoints/{id} | Atualizar endpoint de webhook |
| DELETE | /v1/webhooks/endpoints/{id} | Deletar endpoint de webhook |
| POST | /v1/webhooks/endpoints/{id}/send_test | Enviar um webhook de teste |
| GET | /v1/webhooks/event_types | Listar tipos de evento disponÃÂveis |
| GET | /v1/webhooks/deliveries | Listar entregas de webhook |
| GET | /v1/webhooks/deliveries/{id} | Buscar entrega de webhook por ID |
| POST | /v1/webhooks/deliveries/{id}/retry | Reenviar uma entrega de webhook |