get https://{subdomain}.kommo.com/api/v4//custom_fields
This method allows to get a list of custom fields in the account (leads, companies, contacts)
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
The method returns an array of custom field models. The properties of the custom field object are listed below. Object properties differ depending on the entity.
| Parameter | Data type | Description |
|---|---|---|
| id | int | Field ID |
| name | string | Field name |
| code | string | Field code that can be used to update the value of the field without passing the field ID in the request. |
| sort | int | Field sorting |
| type | int | Field type |
| entity_type | string | Entity type (leads, contacts, companies) |
| is_predefined | bool | Defines whether the field is predefined. This parameter is returned only when getting a contact or company fields list. |
| is_deletable | bool | Defines whether the field is deletable. This parameter is returned only when getting a contact or company fields list. |
| remind | string|null | Birthday reminders setting (never, day – day before the event, week – week before the event, month – month before the event). This value is available only for the birthday type field. This parameter is returned only when getting a list of lead, contact, or company fields. |
| enums | array|null | Available field values array. Only available for the fields with enum values. |
| enums[0] | object | Available field value model |
| enums[0][id] | int | Value ID |
| enums[0][value] | string | Value |
| enums[0][sort] | int | Value sorting |
| is_api_only | bool | Defines whether the field is editable via API only. This parameter is returned only when getting a lead, contact, or company fields list. |
| group_id | string|null | Fields group ID for the current field. This parameter is returned only when getting a lead, contact, company, or customer fields list. |
| required_statuses | array|null | Array of the fields required to change a lead status. This parameter is returned only when getting a lead, contact, or company fields list. |
| required_statuses[0] | object | Required field model. This parameter is returned only when getting a lead, contact, or company fields list. |
| required_statuses[0][status_id] | int | ID of the stage which requires the current field to have a value before the lead can be moved. This parameter is returned only when getting a lead, contact, or company fields list. |
| required_statuses[0][pipeline_id] | int | ID of the pipeline which requires the current field to have a value before the lead can be moved. This parameter is returned only when getting a lead, contact, or company fields list |