List Custom Fields
Returns the list of custom fields configured for your customers in each workspace, together with the available built-in fields.
GET https://api.platica.mx/v1/custom-fieldsResponse
{
"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
}
]
}Response fields
| Field | Description |
|---|---|
id | Unique custom-field identifier (slug derived from the name) |
name | Original field name as defined |
type | Field type (see Create custom field for the full list) |
automatic | Whether the AI should fill the field automatically from the conversation |
overwritable | Whether the AI can overwrite the field's existing value |
description | Description that helps contextualize how the field is used |
status | Field state: active |
ordered | select only. Whether the options are an ordered sequence (stages/steps) |
options | select only. Option catalog. Each option includes id, label, and optionally color, order, and archived. A customer's value for this field is an option id |
defaultFields | Built-in fields available for every customer |
Nota
When using custom fields in your requests, only use lowercase characters without accents or special characters. Use underscores _ instead of spaces.