---
updatedAt: 2025-07-11T14:32:30.000Z
agentTools:
  projectIndex: https://developers.kommo.com/llms.txt
---

# Get an entity field group by ID

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                                                     |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "kommo-api-references",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{subdomain}.kommo.com",
      "variables": {
        "subdomain": {
          "default": "subdomain"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v4/{entity_type}/custom_fields/groups/{id}": {
      "get": {
        "description": "",
        "operationId": "get_apiv4{entity_type}custom_fieldsgroups{id}",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "examples": {
                  "The request is successful": {
                    "summary": "The request is successful",
                    "value": {
                      "id": "leads_52311712151892",
                      "name": "Field group",
                      "is_predefined": false,
                      "type": "custom_field_group",
                      "fields": [
                        782240
                      ],
                      "entity_type": "leads",
                      "sort": 4,
                      "_links": {
                        "self": {
                          "href": "https://subdomain.kommo.com/api/v4/leads/custom_fields/groups/leads_52311712151892"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "User is not authorized": {
                    "value": "{}",
                    "summary": "User is not authorized"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "examples": {
                  "Field group not found": {
                    "value": "{}",
                    "summary": "Field group not found"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "entity_type",
            "schema": {
              "type": "string",
              "default": ""
            },
            "required": true,
            "description": "Type of the entity. Might be: leads/contacts/comapnies"
          },
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string",
              "default": ""
            },
            "required": true,
            "description": "ID of the field group"
          }
        ]
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```