---
updatedAt: 2025-06-08T14:09:58.000Z
---

Fetch the complete documentation index at: https://developers.kommo.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Companies list

The method allows you to get a list of companies

**Limitations**

The method is available in correspondence to the user rights.

**“with” Parameters**

| Parameter         | Description                                                       |
| :---------------- | :---------------------------------------------------------------- |
| leads             | Adds info on the leads linked to the company into the response    |
| contacts          | Adds info on the contacts linked to the company into the response |
| catalog\_elements | Adds lists elements linked to the company into the response       |

**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 properties of a company object are listed below.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parameter
      </th>

      <th>
        Data type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        id
      </td>

      <td>
        int
      </td>

      <td>
        Company ID
      </td>
    </tr>

    <tr>
      <td>
        name
      </td>

      <td>
        string
      </td>

      <td>
        Company name
      </td>
    </tr>

    <tr>
      <td>
        responsible\_user\_id
      </td>

      <td>
        int
      </td>

      <td>
        Company responsible user ID
      </td>
    </tr>

    <tr>
      <td>
        group\_id
      </td>

      <td>
        int
      </td>

      <td>
        Group ID of the company responsible user
      </td>
    </tr>

    <tr>
      <td>
        created\_by
      </td>

      <td>
        int
      </td>

      <td>
        The ID of the user who created the company
      </td>
    </tr>

    <tr>
      <td>
        updated\_by
      </td>

      <td>
        int
      </td>

      <td>
        The ID of the user who updated the company last
      </td>
    </tr>

    <tr>
      <td>
        created\_at
      </td>

      <td>
        int
      </td>

      <td>
        Company creation date in the format of Unix Timestamp
      </td>
    </tr>

    <tr>
      <td>
        updated\_at
      </td>

      <td>
        int
      </td>

      <td>
        Company update date in the format of Unix Timestamp
      </td>
    </tr>

    <tr>
      <td>
        closest\_task\_at
      </td>

      <td>
        int
      </td>

      <td>
        Date of the closest open task in the format of Unix Timestamp
      </td>
    </tr>

    <tr>
      <td>
        custom\_fields\_values
      </td>

      <td>
        array|null
      </td>

      <td>
        An array of the current company custom fields’ values
      </td>
    </tr>

    <tr>
      <td>
        account\_id
      </td>

      <td>
        int
      </td>

      <td>
        Account ID where the company is located in
      </td>
    </tr>

    <tr>
      <td>
        * embedded
      </td>

      <td>
        object
      </td>

      <td>
        Embedded entities data
      </td>
    </tr>

    <tr>
      <td>
        * embedded[tags]
      </td>

      <td>
        array
      </td>

      <td>
        Company tags data array
      </td>
    </tr>

    <tr>
      <td>
        * embedded[tags][0]
      </td>

      <td>
        object
      </td>

      <td>
        Company tag model
      </td>
    </tr>

    <tr>
      <td>
        * embedded[tags][0][id]
      </td>

      <td>
        int
      </td>

      <td>
        Tag ID
      </td>
    </tr>

    <tr>
      <td>
        * embedded[tags][0][name]
      </td>

      <td>
        string
      </td>

      <td>
        Tag name
      </td>
    </tr>

    <tr>
      <td>
        * embedded[tags][0][color]
      </td>

      <td>
        string/null
      </td>

      <td>
        Tag color
      </td>
    </tr>

    <tr>
      <td>
        * embedded[contacts]
      </td>

      <td>
        array
      </td>

      <td>
        **GET parameter “with” is required.**\
        Linked contacts data array
      </td>
    </tr>

    <tr>
      <td>
        * embedded[contacts][0]
      </td>

      <td>
        object
      </td>

      <td>
        Linked contact data
      </td>
    </tr>

    <tr>
      <td>
        * embedded[contacts][0][id]
      </td>

      <td>
        int
      </td>

      <td>
        Linked contact ID
      </td>
    </tr>

    <tr>
      <td>
        * embedded[leads]
      </td>

      <td>
        array
      </td>

      <td>
        **GET parameter “with” is required.**\
        Linked leads data array
      </td>
    </tr>

    <tr>
      <td>
        * embedded[leads][0]
      </td>

      <td>
        object
      </td>

      <td>
        Linked lead data
      </td>
    </tr>

    <tr>
      <td>
        * embedded[leads][0][id]
      </td>

      <td>
        int
      </td>

      <td>
        Linked lead ID
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][catalog_elements]
      </td>

      <td>
        array
      </td>

      <td>
        **GET parameter “with” is required.**\
        Linked lists’ elements data array
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][0]
      </td>

      <td>
        object
      </td>

      <td>
        Linked list element data
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][0][id]
      </td>

      <td>
        int
      </td>

      <td>
        Linked element ID
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][0][metadata]
      </td>

      <td>
        object
      </td>

      <td>
        Meta-data of the element
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][0][quantity]
      </td>

      <td>
        int
      </td>

      <td>
        Linked elements quantity
      </td>
    </tr>

    <tr>
      <td>
        * embedded[catalog\_elements][0][catalog\_id][catalog_id]
      </td>

      <td>
        int
      </td>

      <td>
        ID of the linked element’s list
      </td>
    </tr>
  </tbody>
</Table>

# 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/companies": {
      "get": {
        "summary": "Companies list",
        "description": "The method allows you to get a list of companies",
        "operationId": "companies-list",
        "parameters": [
          {
            "name": "with",
            "in": "query",
            "description": "This parameter takes a string that may consist of several values separated by commas. See the table above.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page of response",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The number of the entities returned in the response to one request (limit – 250)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "query",
            "in": "query",
            "description": "Search query (will perform a search by custom fields values)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order[updated_at]",
            "in": "query",
            "description": "List elements sorting by the time companies were updated at",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          {
            "name": "order[id]",
            "in": "query",
            "description": "List elements sorting by companies IDs",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          {
            "name": "filter[id][]",
            "in": "query",
            "description": "Filter by company ID",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter[name][]",
            "in": "query",
            "description": "Filter by company name",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter[created_by][]",
            "in": "query",
            "description": "Filter by ID of the user who added the company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter[updated_by][]",
            "in": "query",
            "description": "Filter by ID of the user who updated the company last",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter[responsible_user_id][]",
            "in": "query",
            "description": "Filter by ID of the company responsible user",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter[created_at][from]",
            "in": "query",
            "description": "Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added after the date.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filter[created_at][to]",
            "in": "query",
            "description": "Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added before the date.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filter[updated_at][from]",
            "in": "query",
            "description": "Filter by date in Unix Timestamp format when the company was updated. As a response you will get all the companies updated after the date.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filter[updated_at][to]",
            "in": "query",
            "description": "Filter by date in Unix Timestamp format when the company was updated. As a response you will get all the companies updated before the date.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filter[closest_task_at][from]",
            "in": "query",
            "description": "Filter leads by the date of the task closest to completion in Unix Timestamp format.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filter[closest_task_at][to]",
            "in": "query",
            "description": "Filter leads by the date of the task closest to completion in Unix Timestamp format.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Request successful": {
                    "value": "{\n    \"_page\": 1,\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://subdomain.kommo.com/api/v4/companies\"\n        }\n    },\n    \"_embedded\": {\n        \"companies\": [\n            {\n                \"id\": XXXXXX,\n                \"name\": \"United\",\n                \"responsible_user_id\": XXXXXX,\n                \"group_id\": 0,\n                \"created_by\": XXXXX,\n                \"updated_by\": XXXXXX,\n                \"created_at\": 1686670709,\n                \"updated_at\": 1686670709,\n                \"closest_task_at\": null,\n                \"is_deleted\": false,\n                \"custom_fields_values\": null,\n                \"account_id\": XXXX123,\n                \"_links\": {\n                    \"self\": {\n                        \"href\": \"https://subdomain.kommo.com/api/v4/companies/406320\"\n                    }\n                },\n                \"_embedded\": {\n                    \"tags\": []\n                }\n            },\n            {\n                \"id\": 510XXX,\n                \"name\": \"Kommo\",\n                \"responsible_user_id\": 837XYZ,\n                \"group_id\": 0,\n                \"created_by\": 0,\n                \"updated_by\": 0,\n                \"created_at\": 1686754687,\n                \"updated_at\": 1686754687,\n                \"closest_task_at\": null,\n                \"is_deleted\": false,\n                \"custom_fields_values\": null,\n                \"account_id\": XYZ11263,\n                \"_links\": {\n                    \"self\": {\n                        \"href\": \"https://subdomain.kommo.com/api/v4/companies/510864\"\n                    }\n                },\n                \"_embedded\": {\n                    \"tags\": []\n                }\n            },\n            {\n                \"id\": 597XXX,\n                \"name\": \"Atme Co.\",\n                \"responsible_user_id\": 0,\n                \"group_id\": -1,\n                \"created_by\": 0,\n                \"updated_by\": 0,\n                \"created_at\": 1686836351,\n                \"updated_at\": 1686836351,\n                \"closest_task_at\": null,\n                \"is_deleted\": false,\n                \"custom_fields_values\": null,\n                \"account_id\": 3136XXXX,\n                \"_links\": {\n                    \"self\": {\n                        \"href\": \"https://subdomain.kommo.com/api/v4/companies/597516\"\n                    }\n                },\n                \"_embedded\": {\n                    \"tags\": []\n                }\n            }\n        ]\n    }\n}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "The user is not authorized": {
                    "value": ""
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```