get
https://{subdomain}.kommo.com/api/v4//custom_fields/groups/
The method allows you to get a field group of the entity in the account.
Limitations
The method is available to all users of the account.
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
The method returns a field group object.
| Parameter | Data type | Description |
|---|---|---|
| id | int | Field group ID |
| name | string | Field group name |
| sort | string | Field group sorting in the entity card |
| entity_type | int | Type of the entity (leads/contacts/companies) |
| is_predefined | int | Defines if the group is default for the entity. Such groups cannot be deleted |
| type | string | Field group type (linked_group – product groups, custom_field_group – field groups) |
| fields | array | An array of fields IDs of the group |