Digitalk Developers
  1. Empresas Relacionadas
Raiz
  • Raiz
  • CRM
    • CRM — Overview
    • Genérico (data)
      • CRM - Genérico
      • Listar/filtrar registros (qualquer tabela do CRM)
      • Criar/atualizar registros (qualquer tabela do CRM)
      • Hard-delete (não permitido para tabelas company)
    • Empresas Relacionadas
      • CRM - Empresas relacionadas
      • Tipos de relacionamento disponíveis
        GET
      • Listar relacionamentos de uma empresa (ambas as direções)
        GET
      • Criar relacionamento entre duas empresas
        POST
      • Alterar o tipo do relacionamento
        PATCH
      • Inativar relacionamento (reversível)
        PATCH
      • Excluir relacionamento (hard-delete)
        DELETE
    • Ticket ↔ Empresa
      • CRM - Ticket <-> Empresa
      • Empresas elegíveis para o ticket
      • Vincular / trocar a empresa do ticket
    • Templates
      • CRM - Templates
      • Listar templates do tenant (apenas IDs, sem fields)
      • Detalhe completo do template (com fields)
      • Pesquisa formatada por scope (CRMSearchResult)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
      • Criar ticket (básico, com integração CRM opcional)
      • Criar ticket com auto-vínculo / criação de customer via contato
      • Movimentar ticket entre fases (ou finalizar)
      • Atualizar dados do ticket (nome, descrição)
      • Vincular cliente CRM a um ticket existente
      • Adicionar nota ou mensagem ao ticket
    • Workspaces & Workflows
      • Workflow - Workspaces & Workflows
      • Listar workspaces e workflows acessíveis ao usuário
      • Listar fases de um workflow
      • Listar tickets de uma ou mais fases (paginado)
  1. Empresas Relacionadas

Listar relacionamentos de uma empresa (ambas as direções)

GET
/api/v2/empresa-relacionadas/by-empresa/{idEmpresa}
Última modificação:2026-05-28 20:05:32
Retorna os relacionamentos onde a empresa é principal OU relacionada, com
direction (principal/relacionada) + empresa_nome_fantasia/empresa_cnpj
da outra empresa.

⚠️ Status do relacionamento — por padrão devolve ATIVOS + INATIVOS#

PATCH /:id/inactivate seta ativo=false no relacionamento (inativação
reversível, não é soft-delete). Esta listagem mantém o histórico — cada
item carrega o campo ativo pra você distinguir.
Quer verUse
só os ativos (consumo "limpo", picker, integrações)?onlyActive=true
tudo (auditoria, telas de gestão)sem query string (default)
A empresa do outro lado do JOIN é sempre filtrada por deleted_at IS NULL
(empresa hard/soft-deletada não vai aparecer em nenhum dos modos).

⚠️ Diferença entre id e id_empresa_* no retorno#

id = ID do registro de relacionamento (use em PATCH /:id/type, PATCH /:id/inactivate, DELETE /:id).
id_empresa_principal / id_empresa_relacionada = IDs das empresas (linha em empresa.id).

Path param#

{idEmpresa} = id da empresa (campo empresa.id).

Requisição

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v2/empresa-relacionadas/by-empresa/?onlyActive=true' \
--header 'api-key: {{api-key}}'

Respostas

🟢200OK
application/json
Resposta no envelope padrão da API ({ ok, data }). data é a lista de
relacionamentos (vazia se a empresa não tem nenhum). Cada item carrega
direction (principal/relacionada em relação à empresa consultada)
dados da empresa do outro lado.
Bodyapplication/json

Examples
Empresa 1 tem 3 relacionamentos. O id=7 está inativo
(ativo: false) e ainda aparece — é o comportamento default
(visão de auditoria/histórico). Pra esconder o inativo, mande
?onlyActive=true.
{
    "ok": true,
    "data": [
        {
            "id": 7,
            "id_empresa_principal": 1,
            "id_empresa_relacionada": 4,
            "tipo_de_relacionamento": "subsidiaria",
            "ativo": false,
            "direction": "principal",
            "empresa_nome_fantasia": "liber fantasia",
            "empresa_cnpj": "12890301829083",
            "created_by": 23,
            "updated_by": 9800
        },
        {
            "id": 6,
            "id_empresa_principal": 1,
            "id_empresa_relacionada": 3,
            "tipo_de_relacionamento": "filial",
            "ativo": true,
            "direction": "principal",
            "empresa_nome_fantasia": "Midiahub fantasia",
            "empresa_cnpj": "22222222222222",
            "created_by": 23,
            "updated_by": null
        },
        {
            "id": 5,
            "id_empresa_principal": 1,
            "id_empresa_relacionada": 2,
            "tipo_de_relacionamento": "filial",
            "ativo": true,
            "direction": "principal",
            "empresa_nome_fantasia": "Comtexto fantasia",
            "empresa_cnpj": "22222222000122",
            "created_by": 23,
            "updated_by": null
        }
    ]
}
🟠401Não Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
Tipos de relacionamento disponíveis
Próxima página
Criar relacionamento entre duas empresas
Built with