v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Getting the widget info by its code

This method allows getting the information on a public widget or a private widget uploaded by the current user.

get/api/v4/widgets/{widget_code}

Path parameters

widget_codestring required

Widget code

Response

200

idinteger

codestring

versionstring

ratingstring

is_lead_sourceboolean

is_work_with_dpboolean

is_crm_templateboolean

{"stackTrail":"paths:/api/v4/widgets/{widget_code}:get:responses:200:content:application/json:schema:properties:client_uuid","oasType":"schema","type":"unknown"}

is_active_in_accountboolean

{"stackTrail":"paths:/api/v4/widgets/{widget_code}:get:responses:200:content:application/json:schema:properties:pipeline_id","oasType":"schema","type":"unknown"}

Example response

{
  "id": 1234567,
  "code": "birthday",
  "version": "0.0.13",
  "rating": "0",
  "settings_template": [
    {
      "key": "bd",
      "name": "custom",
      "type": "custom"
    }
  ],
  "_links": {
    "self": {
      "href": "https://subdomain.kommo.com/api/v4/widgets/birthday"
    }
  }
}