Digitalk Developers
  1. Templates
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
      • Listar relacionamentos de uma empresa (ambas as direções)
      • Criar relacionamento entre duas empresas
      • Alterar o tipo do relacionamento
      • Inativar relacionamento (reversĂ­vel)
      • Excluir relacionamento (hard-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)
        GET
      • Detalhe completo do template (com fields)
        GET
      • Pesquisa formatada por scope (CRMSearchResult)
        GET
  • 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. Templates

Detalhe completo do template (com fields)

GET
/api/v2/crm/templates/fields_serialized/{template_id}
Última modificação:2026-05-28 20:05:32
Retorna a estrutura completa de um template: todos os fields (colunas)
com type, label, key, required, visible, summable, data.type
(tipo de dado: string, int, customer_name, customer_cpfcnpj,
customer_photo, auto_increment, etc) e data.column (nome real da
coluna no banco).
Use pra montar dinamicamente formulários, validações e payloads de
POST /data/set. O campo fields_serialized (string) Ă© uma versĂŁo
pré-montada do esqueleto do objeto pra criação.

Tipos de campo (fields[i].type)#

simple — coluna comum
join_object — FK que retorna 1 objeto
join_object_list — FK que retorna lista de objetos

Requisição

Parâmetros de Caminho

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

Respostas

🟢200OK
application/json
Template completo com fields[].
Bodyapplication/json

Exemplo
{
    "id": "26cd301a-5c82-468b-9c23-af3c915d9720",
    "name": "Cliente",
    "table_name": "cliente",
    "template_customer_table": true,
    "template_contact_table": false,
    "template_business_table": false,
    "template_default": true,
    "template_default_tenant": false,
    "fields": [
        {
            "column": "id",
            "label": "ID",
            "type": "simple",
            "key": true,
            "constraint_unique": false,
            "summable": false,
            "visible": true,
            "required": true,
            "data": {
                "source_type": "internal_table",
                "type": "auto_increment",
                "table": "cliente",
                "column": "id",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        },
        {
            "column": "nome",
            "label": "Nome",
            "type": "simple",
            "key": false,
            "constraint_unique": false,
            "summable": false,
            "visible": true,
            "required": false,
            "data": {
                "source_type": "internal_table",
                "type": "customer_name",
                "table": "cliente",
                "column": "nome",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        },
        {
            "column": "cpf_cnpj",
            "label": "CPF/CNPJ",
            "type": "simple",
            "key": false,
            "constraint_unique": true,
            "summable": false,
            "visible": true,
            "required": true,
            "data": {
                "source_type": "internal_table",
                "type": "customer_cpfcnpj",
                "table": "cliente",
                "column": "cpf_cnpj",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        }
    ],
    "fields_serialized": "{\"foto\":{\"filename\":\"\",\"url\":\"\"},\"nome\":\"\",\"cpf_cnpj\":\"\",\"teste\":0}",
    "created_at": "2024-05-20T16:05:50.607396Z",
    "updated_at": "2024-08-14T10:57:54.584985Z",
    "created_by": 0
}
đźź 401NĂŁo Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
Listar templates do tenant (apenas IDs, sem fields)
Próxima página
Pesquisa formatada por scope (CRMSearchResult)
Built with