Sign in

v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Custom fields list of a list

This method allows to get a list of list custom fields .

get/api/v4/catalogs/{list_id}/custom_fields

Path parameters

list_idinteger required

List ID

Query parameters

pageinteger

Results page

limitinteger

The number of entities returned per request (limit – 250)

order[sort]'asc' | 'desc'

Sorting of the response list

order[id]'asc' | 'desc'

Sorting of the response list

filter[type][0]'text' | 'numeric' | 'checkbox' | 'select' | 'multiselect' | 'date' | 'url' | 'textarea' | 'radiobutton' | 'streetaddress' | 'smart_address' | 'birthday' | 'date_time' | 'legal_entity' | 'price' | 'category' | 'items'

Field type

Response

200

_total_itemsinteger
_pageinteger
_page_countinteger

Example response

{
  "_total_items": 2,
  "_page": 1,
  "_page_count": 10,
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/leads/custom_fields?limit=2&page=1"
    },
    "next": {
      "href": "https://example.kommo.com/api/v4/leads/custom_fields?limit=2&page=2"
    },
    "last": {
      "href": "https://example.kommo.com/api/v4/leads/custom_fields?limit=2&page=10"
    }
  },
  "_embedded": {
    "custom_fields": [
      {
        "id": 4439091,
        "name": "Text field example",
        "sort": 504,
        "type": "text",
        "required_statuses": [
          {
            "status_id": 41221,
            "pipeline_id": 3142
          }
        ],
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/custom_fields/4439091/"
          }
        }
      }
    ]
  }
}