Listar Campos Personalizados

Obtiene la lista de campos personalizados configurados para tus clientes en cada workspace, junto con los campos predeterminados disponibles.

GET https://api.platica.mx/v1/custom-fields

Respuesta

{
  "workspaces": [
    {
      "id": "ws_123",
      "name": "Soporte Técnico",
      "customFields": [
        {
          "id": "estatus",
          "name": "estatus",
          "type": "text",
          "automatic": false,
          "overwritable": false,
          "description": "Utiliza este campo para indicar el estado actual del cliente",
          "status": "active"
        },
        {
          "id": "etapa_de_venta",
          "name": "Etapa de venta",
          "type": "select",
          "automatic": false,
          "overwritable": false,
          "description": "Etapa actual del cliente en el embudo",
          "status": "active",
          "ordered": true,
          "options": [
            { "id": "nuevo", "label": "Nuevo", "order": 0 },
            { "id": "contactado", "label": "Contactado", "order": 1 },
            { "id": "cerrado", "label": "Cerrado", "order": 2 }
          ]
        }
      ],
      "customFieldsCount": 2,
      "defaultFields": [
        {
          "name": "Nombre",
          "id": "name",
          "type": "text",
          "description": "Nombre completo del cliente"
        }
      ],
      "defaultFieldsCount": 12
    }
  ]
}

Campos de la respuesta

Campo	Descripción
`id`	Identificador único del campo personalizado (slug derivado del nombre)
`name`	Nombre original del campo tal como fue definido
`type`	Tipo del campo (ver Crear campo personalizado para la lista completa)
`automatic`	Si la IA debe llenar el campo automáticamente a partir de la conversación
`overwritable`	Si la IA puede sobrescribir el valor existente del campo
`description`	Descripción que ayuda a contextualizar el uso del campo
`status`	Estado del campo: `active`
`ordered`	Solo `select`. Si las opciones son una secuencia ordenada (etapas/pasos)
`options`	Solo `select`. Catálogo de opciones. Cada opción incluye `id`, `label`, y opcionalmente `color`, `order` y `archived`. El valor de un cliente para este campo es el `id` de una opción
`defaultFields`	Campos predeterminados disponibles para todos los clientes

Nota

Al usar campos personalizados en tus solicitudes, utiliza únicamente minúsculas sin acentos ni caracteres especiales. Usa guiones bajos _ en lugar de espacios.

Anterior Introducción Siguiente Crear Campo Personalizado