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

Tipos de relacionamento disponíveis

GET
/api/v2/empresa-relacionadas/types
Última modificação:2026-05-28 20:05:32
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

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/types' \
--header 'api-key: {{api-key}}'

Respostas

🟢200OK
application/json
Envelope {ok, data} com a lista de tipos.
Bodyapplication/json

Exemplo
{
    "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"
        }
    ]
}
🟠401Não Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
CRM - Empresas relacionadas
Próxima página
Listar relacionamentos de uma empresa (ambas as direções)
Built with