Tipos de relacionamento disponíveis

GET

/api/v2/empresa-relacionadas/types

Retorna a lista de tipos aceitos no campo tipo_de_relacionamento
(usado em POST /empresa-relacionadas e PATCH /:id/type).

Cada item traz value (string a enviar nas APIs) + label (texto pra UI).
A lista é configurável por tenant via metadata do CRM, então
não assuma um conjunto fixo — bate aqui pra descobrir.

Sem body, sem query params — só o header api-key.

Requisição

Parâmetros Header

Respostas

🟢200OK

application/json

Envelope {ok, data} com a lista de tipos.

Bodyapplication/json

🟠401Não Autorizado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v2/empresa-relacionadas/types' \
--header 'api-key: {{api-key}}'

Response Example

200 - Lista padrão (tenant staging — 9 tipos)

{
    "ok": true,
    "data": [
        {
            "value": "filial",
            "label": "Filial"
        },
        {
            "value": "subsidiaria",
            "label": "Subsidiária"
        },
        {
            "value": "fornecedor",
            "label": "Fornecedor"
        },
        {
            "value": "cliente",
            "label": "Cliente"
        },
        {
            "value": "franquia",
            "label": "Franquia"
        },
        {
            "value": "parceiro",
            "label": "Parceiro"
        },
        {
            "value": "terceirizado",
            "label": "Terceirizado"
        },
        {
            "value": "operador",
            "label": "Operador"
        },
        {
            "value": "revenda",
            "label": "Revenda"
        }
    ]
}

Modificado em 2026-11-04 02:31:07

Página anterior

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

Próxima página

Criar relacionamento entre duas empresas