Account Parameters

Method

GET /api/v4/account

Description

The method allows getting the account information.

Limitations

The method is available for all account users.

Authorization type

OAuth 2.0 with Access Token. Review our Step-by-step Example.

GET parameters

Parameter Data type Description
with string This parameter takes a string which may consist of several values separated by commas.
“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.

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

HTTP response codes

Response code Case
200 Request completed successfully
401 User is not authorized

Response example

As a response for the request GET https://devteam.kommo.com/api/v4/account?with=amojo_id,amojo_rights,users_groups,task_types,version,entity_names,datetime_settings

The method returns the account data model.

{
    "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/Moscow",
            "timezone_offset": "+03:00"
        }
    }
}

Response parameters

The properties of the account are listed below.

Parameter Data type Description
id int account ID
name string Account name
subdomain string Account subdomain
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.
customers_mode string Customers functionality. Possible values: unavailable (functionality is unavailable), disabled (functionality is disabled), segments (segmentation view), dynamic (deprecated), periodicity (recurring purchases view)
is_unsorted_on bool Is the “Incoming leads” functionality is enabled?
is_loss_reason_enabled bool Is the “Reason for close-lost leads” functionality enabled?
is_helpbot_enabled bool Is the “AI power-up” functionality enabled? (available only on the Enterprise subscription plan).
is_technical_account bool Is the account 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” is required. Unique account identifier in the online chat service amojo.
version int GET parameter “with” is required. Current Kommo version
_embedded[amojo_rights] object GET parameter “with” is required. Chats settings object.
_embedded[amojo_rights][can_direct] object GET parameter “with” is required. Defines whether internal chats are available.
_embedded[amojo_rights][can_create_groups] object GET parameter “with” is required. Defines whether group chats are available.
_embedded[users_groups] array GET parameter “with” is required. Array of the Kommo user groups objects.
_embedded[users_groups][0][id] int GET parameter “with” is required. User group ID.
_embedded[users_groups][0][name] string GET parameter “with” is required. User group name.
_embedded[task_types] array GET parameter “with” is required. Task types on the account.
_embedded[task_types][0][id] int GET parameter “with” is required. Task type ID.
_embedded[task_types][0][name] string GET parameter “with” is required. Task type name.
_embedded[task_types][0][color] string GET parameter “with” is required. Task type color
_embedded[task_types][0][icon_id] int GET parameter “with” is required. Task type icon ID.
_embedded[task_types][0][code] string GET parameter “with” is required. Task type code.
_embedded[datetime_settings] object GET parameter “with” is required. Date and time settings and format in the account.
_embedded[entity_names] object GET parameter “with” is required. Entities names settings.