get https://{subdominio}.kommo.com/api/v4//custom_fields/
Este método permite obtener una lista de campos personalizados en la cuenta (leads, compañías, contactos).
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, compañías). |
| is_predefined | bool | Define 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 | Define si el campo se puede eliminar. Este parámetro solo se retorna al obtener la lista de campos de contactos o compañías. |
| remind | string|null | Configuración de recordatorios de cumpleaños (nunca, día – día antes del evento, semana – semana antes del evento, mes – 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 | Arreglo de valores disponibles para el campo. Solo disponible para los campos con valores enumerados. |
| enums[0] | object | Modelo de valor de campo disponible. |
| enums[0][id] | int | ID del valor. |
| enums[0][value] | string | Valor. |
| enums[0][sort] | int | Ordenación de valores. |
| is_api_only | bool | Define 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[0][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[0][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. |