get https://{subdominio}.kommo.com/api/v4/widgets/
Este método permite obtener la información de un widget público o de un widget privado subido por el usuario actual.
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 widget.
Parámetro | Tipo de dato | Descripción |
---|---|---|
id | int | ID del widget. |
code | string | Código del widget. |
version | string | Versión del widget. |
rating | string|float | Calificación del widget (el sistema de calificaciones aún no existe en Kommo). |
settings_template | array | Un arreglo con los campos de configuración del widget. |
settings_template[0] | obj | Campo de configuración del widget. |
settings_template[0][key] | string | Clave del valor del campo. |
settings_template[0][name] | string | Nombre del campo de configuración del widget. |
settings_template[0][type] | string | Tipo de dato del campo de configuración (text, pass, custom, users o users_lp). |
settings_template[0][is_required] | bool | Indica si completar el campo es obligatorio. |
is_lead_source | bool | Indica si el widget puede configurarse como fuente de leads. |
is_work_with_dp | bool | Indica si el widget está disponible en el Pipeline Digital. |
is_crm_template | bool | Indica si el widget es una plantilla de CRM. |
client_uuid | string|null | UUID de la integración oAuth del widget. |
is_active_in_account | bool | Indica si el widget está instalado en la cuenta. |
pipeline_id | int | ID del pipeline donde el widget está configurado como fuente de leads. |
settings | array | Configuraciones del widget. La clave solo se retorna cuando una integración solicita sus propias configuraciones. |