get
https://{subdominio}.kommo.com/api/v4/catalogs//custom_fields
Este método permite obtener una lista de los campos personalizados de una lista.
Limitaciones
El método está disponible para todos los usuarios de la cuenta.
Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json
Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json
Parámetros de respuesta
El método retorna un arreglo de objetos de campos personalizados. Las propiedades del objeto campo personalizado se enumeran a continuación. Las propiedades del objeto varían según la entidad.
| Parámetro | Tipo de dato | Descripción |
|---|---|---|
| id | int | ID del campo |
| name | string | Nombre del campo |
| code | string | Código del campo que se puede utilizar para actualizar el valor del campo sin pasar el ID del campo en la solicitud. |
| sort | int | Ordenación de los campos |
| type | int | Tipo de campo |
| entity_type | string | Tipo de entidad (leads, contactos, companies) |
| is_predefined | bool | Indica si el campo es predefinido. Este parámetro solo se retorna al obtener la lista de campos de contactos o compañías. |
| is_deletable | bool | Indica si el campo se puede eliminar. Este parámetro solo se retorna al obtener la lista de campos de contactos o compañías. |
| currency | string|null | |
| remind | string|null | Configuración de recordatorios de cumpleaños never, day – día antes del evento, week – semana antes del evento, month – mes antes del evento). Este valor solo está disponible para el campo de tipo cumpleaños. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| enums | array|null | Array de valores disponibles para el campo. Solo disponible para los campos con valores enumerados |
| enums[0] | object | Modelo del valor disponible para el campo |
| enums[id] | int | ID del valor |
| enums[value] | string | Valor |
| enums[sort] | int | Orden de los valores |
| enums[code] | string | Código simbólico de la enumeración |
| is_api_only | bool | Indica si el campo es editable solo a través de la API. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| group_id | string|null | ID del grupo de campos para el campo actual. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| required_statuses | array|null | Arreglo de los campos requeridos para cambiar el estado de un lead. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| required_statuses[0] | object | Modelo de campo requerido. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| required_statuses[status_id] | int | ID de la etapa que requiere que el campo actual tenga un valor antes de que el lead pueda ser movido. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| required_statuses[pipeline_id] | int | ID del pipeline que requiere que el campo actual tenga un valor antes de que el lead pueda ser movido. Este parámetro solo se retorna al obtener una lista de campos de leads, contactos o compañías. |
| hidden_statuses | array | Configuración para ocultar campos. Los campos se ocultan en la interfaz de usuario según su etapa en el pipeline. Esta clave solo se devuelve al recuperar la lista de campos de leads |
| hidden_statuses[0] | object | Modelo de configuración para ocultar campos |
| hidden_statuses[0][status_id] | int | ID de la etapa en la que el campo está oculto |
| hidden_statuses[0][pipeline_id] | int | ID del pipeline en el que el campo está oculto |
| chained_lists | array|null | Configuración de un campo de tipo chained_list. La clave solo se devuelve al recuperar la lista de campos de leads |
| chained_lists[0] | obj | Modelo de configuración de lista encadenada |
| chained_lists[0][title] | string|null | El nombre de la lista encadenada que se muestra en la tarjeta del lead |
| chained_lists[0][catalog_id] | int | ID del catálogo |
| chained_lists[0][parent_catalog_id] | int | ID del catálogo principal |
| tracking_callback | string | Una función callback de JavaScript que se ejecuta en la página que contiene un botón de chat y un formulario web de Kommo cuando se envían los datos. Este valor se devuelve para los campos de tipo tracking_data. |
| search_in | string|null | ID del catálogo o código simbólico (contacts, companies, contacts_and_companies) para un campo de tipo linked_entity. |