Account Parameters

Account parameters

Method

GET /api/v4/account

Description

The method allows getting the required account info, i.e. ID, name, task types list, user groups, etc.

Limitations

The method is available for all account users.

GET parameters

Parameter	Data type	Description
with	string	This parameter takes a string which may consist of several values separated by commas. This method supports the following parameters.

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 successful
401	The user is not authorized

Response parameters

The method returns the account data model. 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.
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	Defines whether “Incoming leads” functionality is enabled.
is_loss_reason_enabled	bool	Defines whether the loss reason functionality is enabled.
is_helpbot_enabled	bool	Define the whether AI power-up functionality is enabled (available only on the Enterprise subscription plan).
is_technical_account	bool	Defines whether the account is technical.
contact_name_display_order	int	Contact name display order (1 – First Name, Last Name; 2 – Last Name, First Name)
amojo_id	string	GET parameter “with” is required. Unique account identifier for the 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. Settings and format of the date and time on the account.
_embedded[entity_names]	object	GET parameter “with” is required. Entities names settings.

Response example


{
    "id": 1231414,
    "name": "example",
    "subdomain": "example",
    "current_user_id": 581651,
    "country": "EN",
    "customers_mode": "segments",
    "is_unsorted_on": true,
    "is_loss_reason_enabled": true,
    "is_helpbot_enabled": false,
    "is_technical_account": false,
    "contact_name_display_order": 1,
    "amojo_id": "f3c6340d-410e-4ad1-9f7e-c5e663599909",
    "uuid": "824f3a59-6154-4edf-ba90-0b5593715d07",
    "version": 11,
    "_links": {
        "self": {
            "href": "https://example.kommo.com/api/v4/account"
        }
    },
    "_embedded": {
        "amojo_rights": {
            "can_direct": true,
            "can_create_groups": true
        },
        "users_groups": [
            {
                "id": 0,
                "name": "Sales Team",
                "uuid": null
            }
        ],
        "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"
            }
        ],
        "entity_names": {
            "leads": {
                "en": {
                    "singular_form": {
                        "default": "lead"
                    },
                    "plural_form": {
                        "default": "leads"
                    },
                    "gender": "f"
                },
                "es": {
                    "singular_form": {
                        "default": "acuerdo"
                    },
                    "plural_form": {
                        "default": "acuerdos"
                    },
                    "gender": "m"
                }
            }
        },
        "datetime_settings": {
            "date_pattern": "d.m.Y H:i",
            "short_date_pattern": "d.m.Y",
            "short_time_pattern": "H:i",
            "date_formant": "d.m.Y",
            "time_format": "H:i:s",
            "timezone": "Europe/Moscow",
            "timezone_offset": "+03:00"
        }
    }
}

Parameters for GET-parameters “with”

Parameter	Description
amojo_id	Adds the chat service ID into the response.
amojo_rights	Adds the info on the availability of the direct and group chats functionality for account users into the response.
users_groups	Adds the info on the available user groups into the response.
task_types	Adds the info on the available task types into the response.
version	Adds the info on the current Kommo version into the response.
entity_names	Adds the entities’ names with their translations into the response.
datetime_settings	Adds the info on the current date and time settings on the account into the response.