Listar relacionamentos de uma empresa (ambas as direções)
GET
/api/v2/empresa-relacionadas/by-empresa/{idEmpresa}
direction (principal/relacionada) + empresa_nome_fantasia/empresa_cnpjda outra empresa.
⚠️ Status do relacionamento — por padrão devolve ATIVOS + INATIVOS
PATCH /:id/inactivate seta ativo=false no relacionamento (inativaçãoreversível, não é soft-delete). Esta listagem mantém o histórico — cada
item carrega o campo
ativo pra você distinguir.| Quer ver | Use |
|---|---|
| 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
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v2/empresa-relacionadas/by-empresa/?onlyActive=true' \
--header 'api-key: {{api-key}}'Response Response Example
200 - Sem `?onlyActive` (default) — devolve ativos + inativos
{
"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": "Empresa Exemplo Fantasia",
"empresa_cnpj": "22222222000122",
"created_by": 23,
"updated_by": null
}
]
}Modificado em 2026-11-04 03:37:52