Sign in

v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get entity field by ID

This method allows to get a list of custom fields in the account (leads, companies, contacts)

get/api/v4/{entity_type}/custom_fields/{id}

Path parameters

entity_type'leads' | 'companies' | 'contacts' required

Entity type

idinteger required

Custom field ID

Response

200

idinteger
namestring
typestring
account_idinteger
codestring
sortinteger
is_api_onlyboolean
{"stackTrail":"paths:/api/v4/{entity_type}/custom_fields/{id}:get:responses:200:content:application/json:schema:properties:group_id","oasType":"schema","type":"unknown"}
is_deletableboolean
is_predefinedboolean
entity_typestring
{"stackTrail":"paths:/api/v4/{entity_type}/custom_fields/{id}:get:responses:200:content:application/json:schema:properties:remind","oasType":"schema","type":"unknown"}

Example response

{
  "id": 3,
  "name": "Phone",
  "type": "multitext",
  "account_id": 28805383,
  "code": "PHONE",
  "sort": 4,
  "enums": [
    {
      "id": 1,
      "value": "WORK",
      "sort": 2
    }
  ],
  "is_predefined": true,
  "entity_type": "contacts",
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/contacts/custom_fields/3"
    }
  }
}