get https://{subdomain}.kommo.com/api/v4/widgets
This method returns an aggregated list of public widgets installed on the account as well as widgets added by the current user.
Limitations
The method is available for all account users.
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Response parameters
Method returns an array of widget objects.
| Parameter | Data type | Description |
|---|---|---|
| id | int | Widget ID |
| code | string | Widget code |
| version | string | Widget version |
| rating | string|float | Widget rating (rating system doesn't exist on Kommo yet) |
| settings_template | array | An array of widget settings fields |
| settings_template[0] | obj | Widget settings field |
| settings_template[0][key] | string | Field value key |
| settings_template[0][name] | string | Widget settings field name |
| settings_template[0][type] | string | Widget settings field data type (text, pass, custom, users, or users_lp) |
| settings_template[0][is_required] | bool | Shows whether filling in the is mandatory |
| is_lead_source | bool | Shows whether a widget can be set as a lead source |
| is_work_with_dp | bool | Shows whether a widget is available in Digital Pipeline |
| is_crm_template | bool | Shows whether a widget is a CRM template |
| client_uuid | string|null | UUID of the widget’s oAuth integration |
| is_active_in_account | bool | Shows whether the widget is installed in the account |
| pipeline_id | int | Pipeline ID where a widget is set as a lead source |