---
updatedAt: 2026-07-22T08:23:36.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.
# Account parameters
The method allows getting the account information.
**Limitations**
The method is available for all account users.
**“with” Parameters**
| Parameter | Description |
| :----------------- | :-------------------------------------------------------------------------------------------------------------------------- |
| amojo\_id | Adds the account ID in the online chat service to the response |
| amojo\_rights | Adds in response information about the availability of the functionality for creating group and using direct chats by users |
| users\_groups | Adds information about the available groups of account users to the response |
| task\_types | Adds to the response information about the available types of tasks in the account |
| version | Adds information about the current version of Kommo to the response |
| entity\_names | Adds entity names to the response with their translations and number forms |
| datetime\_settings | Adds to the response information about the current settings of the account’s date and time formats |
| drive\_url | Adds the file service address for the requested 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
| Parameter | Data type | Description |
| :----------------------------------------------- | :-------- | :--------------------------------------------------------------------------------------------------------------- |
| id | int | Account ID |
| name | string | Account name |
| subdomain | string | Account subdomain |
| language | string | Account language |
| current\_user\_id | int | Current user ID |
| country | string | Country specified in the account settings |
| currency | string | Currency specified in the account settings |
| currency\_symbol | string | Currency symbol |
| is\_unsorted\_on | bool | Defines if the **Incoming leads** functionality is enabled |
| is\_loss\_reason\_enabled | bool | Defines if the **Reason for close-lost leads** functionality is enabled |
| is\_helpbot\_enabled | bool | Defines if the **AI power-up** functionality is enabled (available only on the **Enterprise** subscription plan) |
| is\_technical\_account | bool | Defines if the account is technical |
| contact\_name\_display\_order | int | Defines the order of the contact’s name (1 – First Name, Last Name; 2 – Last Name, First Name). |
| amojo\_id | string | **GET parameter** `?with=amojo_id` **is required**. Unique account ID in the `amojo` chat service |
| version | int | **GET parameter** `?with=version` **is required**. Current Kommo version |
| drive\_url | string | **GET parameter** `?with=drive_url` **is required**. The file service address for a specific account. |
| \_embedded\[amojo\_rights] | obj | **GET parameter** `?with=amojo_rights` **is required**. Account chats settings object |
| \_embedded\[amojo\_rights]\[can\_direct] | obj | Defines if internal chats are available |
| \_embedded\[amojo\_rights]\[can\_create\_groups] | obj | Defines if group chats are available |
| \_embedded\[users\_groups] | array | **GET parameter** `?with=users_groups` **is required**. Array of the Kommo user groups objects |
| \_embedded\[users\_groups]\[0]\[id] | int | User group ID |
| \_embedded\[users\_groups]\[0]\[name] | string | User group name |
| \_embedded\[task\_types] | array | **GET parameter** `?with=task_types` **is required**. Task types of the account |
| \_embedded\[task\_types]\[0]\[id] | int | Task type ID |
| \_embedded\[task\_types]\[0]\[name] | string | Task type name |
| \_embedded\[task\_types]\[0]\[color] | string | Task type color |
| \_embedded\[task\_types]\[0]\[icon\_id] | int | Task type icon ID |
| \_embedded\[task\_types]\[0]\[code] | string | Task type code |
| \_embedded\[datetime\_settings] | obj | **GET parameter** `?with=datetime_settings` **is required**. Date and time settings and format in the account |
| \_embedded\[entity\_names] | obj | **GET parameter** `?with=entity_names` **is required**. Entities names settings |
# 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/account": {
"get": {
"summary": "Account parameters",
"description": "The method allows getting the account information.",
"operationId": "account-parameters",
"parameters": [
{
"name": "with",
"in": "query",
"description": "This parameter takes a string which may consist of several values (`with` parameters table) separated by commas.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"examples": {
"Request successful": {
"value": {
"id": 30896271,
"name": "Developers Team",
"subdomain": "devteam",
"current_user_id": 8375357,
"country": "US",
"currency": "USD",
"currency_symbol": "$",
"customers_mode": "disabled",
"is_unsorted_on": true,
"mobile_feature_version": 0,
"is_loss_reason_enabled": true,
"is_helpbot_enabled": false,
"is_technical_account": true,
"contact_name_display_order": 1,
"amojo_id": "b46280ba-68e1-44ff-b74a-ff0f577d49d7",
"version": 15,
"entity_names": {
"leads": {
"en": {
"singular_form": {
"default": "lead"
},
"plural_form": {
"default": "leads"
},
"gender": "f"
},
"es": {
"singular_form": {
"default": "lead"
},
"plural_form": {
"default": "leads"
},
"gender": "m"
},
"pt": {
"singular_form": {
"default": "lead"
},
"plural_form": {
"default": "leads"
},
"gender": "f"
}
},
"invoices": {
"en": {
"singular_form": {
"default": "invoice/purchase",
"genitive": "invoice/purchase",
"dative": "invoice/purchase",
"accusative": "invoice/purchase",
"instrumental": "invoice/purchase",
"prepositional": "invoice/purchase"
},
"plural_form": {
"default": "invoices/purchases",
"genitive": "invoices/purchases",
"dative": "invoices/purchases",
"accusative": "invoices/purchases",
"instrumental": "invoices/purchases",
"prepositional": "invoices/purchases"
},
"gender": "f"
},
"es": {
"singular_form": {
"default": "factura/compra",
"genitive": "factura/compra",
"dative": "factura/compra",
"accusative": "factura/compra",
"instrumental": "factura/compra",
"prepositional": "factura/compra"
},
"plural_form": {
"default": "facturas/compras",
"genitive": "facturas/compras",
"dative": "facturas/compras",
"accusative": "facturas/compras",
"instrumental": "facturas/compras",
"prepositional": "facturas/compras"
},
"gender": "f"
},
"pt": {
"singular_form": {
"default": "fatura/compra",
"genitive": "fatura/compra",
"dative": "fatura/compra",
"accusative": "fatura/compra",
"instrumental": "fatura/compra",
"prepositional": "fatura/compra"
},
"plural_form": {
"default": "faturas/compras",
"genitive": "faturas/compras",
"dative": "faturas/compras",
"accusative": "faturas/compras",
"instrumental": "faturas/compras",
"prepositional": "faturas/compras"
},
"gender": "f"
}
}
},
"_links": {
"self": {
"href": "https://devteam.kommo.com/api/v4/account"
}
},
"_embedded": {
"amojo_rights": {
"can_direct": true,
"can_create_groups": true
},
"users_groups": [
{
"id": 0,
"name": "Sales Office"
}
],
"task_types": [
{
"id": 1,
"name": "Follow-up",
"color": null,
"icon_id": null,
"code": "FOLLOW_UP"
},
{
"id": 2,
"name": "Meeting",
"color": null,
"icon_id": null,
"code": "MEETING"
}
],
"datetime_settings": {
"date_pattern": "m/d/Y g:iA",
"short_date_pattern": "m/d/Y",
"short_time_pattern": "g:iA",
"date_format": "m/d/Y",
"time_format": "g:i:sA",
"timezone": "Europe/Istanbul",
"timezone_offset": "+03:00"
}
}
},
"summary": "Request successful"
}
},
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 30896271,
"default": 0
},
"name": {
"type": "string",
"example": "Developers Team"
},
"subdomain": {
"type": "string",
"example": "devteam"
},
"current_user_id": {
"type": "integer",
"example": 8375357,
"default": 0
},
"country": {
"type": "string",
"example": "US"
},
"currency": {
"type": "string",
"example": "USD"
},
"currency_symbol": {
"type": "string",
"example": "$"
},
"customers_mode": {
"type": "string",
"example": "disabled"
},
"is_unsorted_on": {
"type": "boolean",
"example": true,
"default": true
},
"mobile_feature_version": {
"type": "integer",
"example": 0,
"default": 0
},
"is_loss_reason_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"is_helpbot_enabled": {
"type": "boolean",
"example": false,
"default": true
},
"is_technical_account": {
"type": "boolean",
"example": true,
"default": true
},
"contact_name_display_order": {
"type": "integer",
"example": 1,
"default": 0
},
"amojo_id": {
"type": "string",
"example": "b46280ba-68e1-44ff-b74a-ff0f577d49d7"
},
"version": {
"type": "integer",
"example": 15,
"default": 0
},
"entity_names": {
"type": "object",
"properties": {
"leads": {
"type": "object",
"properties": {
"en": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "lead"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "leads"
}
}
},
"gender": {
"type": "string",
"example": "f"
}
}
},
"es": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "lead"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "leads"
}
}
},
"gender": {
"type": "string",
"example": "m"
}
}
},
"pt": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "lead"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "leads"
}
}
},
"gender": {
"type": "string",
"example": "f"
}
}
}
}
},
"invoices": {
"type": "object",
"properties": {
"en": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "invoice/purchase"
},
"genitive": {
"type": "string",
"example": "invoice/purchase"
},
"dative": {
"type": "string",
"example": "invoice/purchase"
},
"accusative": {
"type": "string",
"example": "invoice/purchase"
},
"instrumental": {
"type": "string",
"example": "invoice/purchase"
},
"prepositional": {
"type": "string",
"example": "invoice/purchase"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "invoices/purchases"
},
"genitive": {
"type": "string",
"example": "invoices/purchases"
},
"dative": {
"type": "string",
"example": "invoices/purchases"
},
"accusative": {
"type": "string",
"example": "invoices/purchases"
},
"instrumental": {
"type": "string",
"example": "invoices/purchases"
},
"prepositional": {
"type": "string",
"example": "invoices/purchases"
}
}
},
"gender": {
"type": "string",
"example": "f"
}
}
},
"es": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "factura/compra"
},
"genitive": {
"type": "string",
"example": "factura/compra"
},
"dative": {
"type": "string",
"example": "factura/compra"
},
"accusative": {
"type": "string",
"example": "factura/compra"
},
"instrumental": {
"type": "string",
"example": "factura/compra"
},
"prepositional": {
"type": "string",
"example": "factura/compra"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "facturas/compras"
},
"genitive": {
"type": "string",
"example": "facturas/compras"
},
"dative": {
"type": "string",
"example": "facturas/compras"
},
"accusative": {
"type": "string",
"example": "facturas/compras"
},
"instrumental": {
"type": "string",
"example": "facturas/compras"
},
"prepositional": {
"type": "string",
"example": "facturas/compras"
}
}
},
"gender": {
"type": "string",
"example": "f"
}
}
},
"pt": {
"type": "object",
"properties": {
"singular_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "fatura/compra"
},
"genitive": {
"type": "string",
"example": "fatura/compra"
},
"dative": {
"type": "string",
"example": "fatura/compra"
},
"accusative": {
"type": "string",
"example": "fatura/compra"
},
"instrumental": {
"type": "string",
"example": "fatura/compra"
},
"prepositional": {
"type": "string",
"example": "fatura/compra"
}
}
},
"plural_form": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "faturas/compras"
},
"genitive": {
"type": "string",
"example": "faturas/compras"
},
"dative": {
"type": "string",
"example": "faturas/compras"
},
"accusative": {
"type": "string",
"example": "faturas/compras"
},
"instrumental": {
"type": "string",
"example": "faturas/compras"
},
"prepositional": {
"type": "string",
"example": "faturas/compras"
}
}
},
"gender": {
"type": "string",
"example": "f"
}
}
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"example": "https://devteam.kommo.com/api/v4/account"
}
}
}
}
},
"_embedded": {
"type": "object",
"properties": {
"amojo_rights": {
"type": "object",
"properties": {
"can_direct": {
"type": "boolean",
"example": true,
"default": true
},
"can_create_groups": {
"type": "boolean",
"example": true,
"default": true
}
}
},
"users_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 0,
"default": 0
},
"name": {
"type": "string",
"example": "Sales Office"
}
}
}
},
"task_types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1,
"default": 0
},
"name": {
"type": "string",
"example": "Follow-up"
},
"color": {},
"icon_id": {},
"code": {
"type": "string",
"example": "FOLLOW_UP"
}
}
}
},
"datetime_settings": {
"type": "object",
"properties": {
"date_pattern": {
"type": "string",
"example": "m/d/Y g:iA"
},
"short_date_pattern": {
"type": "string",
"example": "m/d/Y"
},
"short_time_pattern": {
"type": "string",
"example": "g:iA"
},
"date_format": {
"type": "string",
"example": "m/d/Y"
},
"time_format": {
"type": "string",
"example": "g:i:sA"
},
"timezone": {
"type": "string",
"example": "Europe/Istanbul"
},
"timezone_offset": {
"type": "string",
"example": "+03:00"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/problem+json": {
"examples": {
"Incorrect data transmitted. Details are available in the response body": {
"value": "{\n \"title\": \"Bad Request\",\n \"type\": \"https://httpstatus.es/400\",\n \"status\": 400,\n \"detail\": \"Invalid with\"\n}",
"summary": "Incorrect data transmitted. Details are available in the response body"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/problem+json": {
"examples": {
"User unauthorized": {
"summary": "User unauthorized",
"value": {
"title": "Unauthorized",
"type": "https://httpstatus.es/401",
"status": 401,
"detail": "Invalid user name or password"
}
}
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/problem+json": {
"examples": {
"Too many requests": {
"value": "{}",
"summary": "Too many requests"
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/problem+json": {
"examples": {
"Internal server error": {
"value": "The server encountered an error and couldn't complete your request.",
"summary": "Internal server error"
}
}
}
}
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```