Listar tipos de relacionamento

GET

/api/v2/cliente-empresas/types

Lista os tipos de relacionamento aceitos neste ambiente.

No envio, use o value, não o label. A lista pode ser editada pelo
ambiente; nao_informado sempre existe e é o tipo dos vínculos criados
automaticamente.

Requisição

Parâmetros Header

Respostas

🟢200OK

application/json

Lista de tipos.

Bodyapplication/json

🟠401Não Autorizado

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v2/cliente-empresas/types' \
--header 'api-key: {{api-key}}'

Response Example

200 - Lista padrão

{
    "ok": true,
    "data": [
        {
            "value": "funcionario",
            "label": "Funcionário"
        },
        {
            "value": "operador",
            "label": "Operador"
        },
        {
            "value": "socio_administrador",
            "label": "Sócio / Administrador"
        },
        {
            "value": "representante",
            "label": "Representante"
        },
        {
            "value": "procurador",
            "label": "Procurador"
        },
        {
            "value": "consumidor",
            "label": "Consumidor"
        },
        {
            "value": "fornecedor",
            "label": "Fornecedor"
        },
        {
            "value": "contador",
            "label": "Contador"
        },
        {
            "value": "consultor",
            "label": "Consultor"
        },
        {
            "value": "outro",
            "label": "Outro"
        },
        {
            "value": "nao_informado",
            "label": "Não informado"
        }
    ]
}

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

Página anterior

Pesquisa formatada por scope (CRMSearchResult)

Próxima página

Listar empresas de um cliente