Ir al contenido

Custom Fields (Campos personalizados)

GET /v1/custom-fields

Solo lectura. Retorna las definiciones de campos personalizados para clientes. Útil para saber qué UUIDs usar al filtrar o al crear/actualizar clientes.

Query Parameters:

ParámetroTipoDefaultDescripción
orderBystringsortOrderCampo para ordenar
orderstringascDirección del orden

Respuesta exitosa: 200 OK

{
"total": 3,
"items": [
{
"id": "dd0e8400-e29b-41d4-a716-446655440009",
"name": "Tipo de cliente",
"type": "select",
"required": true,
"options": ["regular", "premium", "vip"],
"sortOrder": 1,
"showInMinisite": 1,
"requiredInMinisite": 0,
"showInIaAgent": 1,
"requiredInIaAgent": 0
},
{
"id": "ee0e8400-e29b-41d4-a716-446655440010",
"name": "Fuente de referencia",
"type": "text",
"required": false,
"options": null,
"sortOrder": 2,
"showInMinisite": 0,
"requiredInMinisite": 0,
"showInIaAgent": 0,
"requiredInIaAgent": 0
}
]
}

Schema de CustomField:

CampoTipoDescripción
idstringUUID del campo (usar como fieldId al crear/actualizar clientes y como field en filtros)
namestringNombre descriptivo
typestringTipo: text, select, number, etc.
requiredbooleanSi es requerido
optionsarray | nullOpciones disponibles (para tipo select)
sortOrderintegerOrden de visualización
showInMinisiteintegerVisible en minisite (0/1)
requiredInMinisiteintegerRequerido en minisite (0/1)
showInIaAgentintegerVisible para agente IA (0/1)
requiredInIaAgentintegerRequerido para agente IA (0/1)