Параметры аккаунта

Данный метод API позволяет получить необходимую информацию по аккаунту, например: название, справочник типов задач, группы пользователей и другие параметры.

Метод доступен всем пользователям аккаунта.

Данный метод возвращает данные типа Content-Type:application/hal+json

URL метода

GET /api/v4/account

Параметры

Параметр Описание
with Если в параметре with указать значения (список см. здесь), в ответ придёт информация из аккаунта по соответствующему значению.

Данный метод поддерживает запрос нескольких дополнительных параметров. Для их получения, нужно указать несколько значений через “,”. Например /api/v4/account?with=amojo_id,users_groups,task_types

Возможные значения GET параметра with

Значение Описание
amojo_id Добавляет в ответ ID аккаунта в amojo
amojo_rights Добавляет в ответ информацию о доступности функционала создания групповых и использования директ чатов пользователями
users_groups Добавляет в ответ информацию о доступных группах пользователей аккаунта
task_types Добавляет в ответ информацию о доступных типах задач в аккаунте
version Добавляет в ответ информацию о текущей версии amoCRM
entity_names Добавляет в ответ названия сущностей с их переводами и формами чисел
datetime_settings Добавляет в ответ информацию о текущих настройках форматов даты и времени аккаунта

Параметры ответа

Параметр Тип Описание
id int Уникальный идентификатор аккаунта
name string Название аккаунта
subdomain string Уникальный субдомен данного аккаунта
created_at timestamp Дата создания аккаунта
created_by int ID пользователя, который создал аккаунт
updated_at timestamp Дата последнего изменения свойств аккаунта
updated_by int ID пользователя, который последним менял свойства аккаунта
current_user_id int ID текущего пользователя
country string Страна, указанная в настройках аккаунта
customers_mode string Режим покупателей. Возможные варианты: unavailable (функционал недоступен), disabled (функцонал отключен), segments (сегментация), dynamic (deprecated), periodicity (периодические покупки)
is_unsorted_on bool Включен ли функционал “Неразобранного” в аккаунте
is_loss_reason_enabled bool Включен ли функционал причин отказа
is_helpbot_enabled bool Включен ли функционал Типовых вопросов (доступен только на профессиональном тарифе)
is_technical_account bool Является ли данный аккаунт техническим
contact_name_display_order int Порядок отображения имен контактов (1 – Имя, Фамилия; 2 – Фамилия, Имя)

Параметры ответа, которые зависят от GET параметра with

Значение Тип Параметр with Описание
amojo_id int amojo_id Уникальный идентификатор аккаунта для работы с сервисом чатов amoJo
version int version Текущая версия amoCRM
_embedded/amojo_rights array amojo_rights Объект настроек чатов
_embedded/amojo_rights/can_direct bool amojo_rights Доступны ли внутренние чаты
_embedded/amojo_rights/can_create_groups bool amojo_rights Доступна ли возможность создавать групповые чаты
_embedded/users_groups array users_groups Группы пользователей аккаунта
_embedded/users_groups//id int users_groups ID группы
_embedded/users_groups//name string users_groups Название группы
_embedded/task_types array task_types Типы задач, доступные в данном аккаунте
_embedded/task_types//id int task_types ID типа задачи
_embedded/task_types//name string task_types Название типа задачи
_embedded/task_types//color string task_types Цвет типа задачи
_embedded/task_types//icon_id int task_types ID иконки типа задачи
_embedded/task_types/code string task_types Код типа задачи
_embedded/datetime_settings array datetime_settings Настройки формата даты и времени (описание формата см. здесь)
_embedded/datetime_settings/timezone string datetime_settings Часовой пояс аккаунта
_embedded/datetime_settings/timezone_offset datetime_settings string Смещение часового пояса аккаунта от UTC

Формат даты

Код Описание
D Текстовое представление дня недели, 3 символа
d День месяца, 2 цифры с ведущим нулём
M Сокращенное наименование месяца, 3 символа
m Порядковый номер месяца с ведущим нулём
Y Порядковый номер года, 4 цифры
H Часы в 24-часовом формате с ведущим нулём
i Минуты с ведущим нулём
s Секунды с ведущим нулём

Пример ответа


{
    "id": 1231414,
    "name": "example",
    "subdomain": "example",
    "created_at": 1585840134,
    "created_by": 321321,
    "updated_at": 1589472711,
    "updated_by": 321321,
    "current_user_id": 581651,
    "country": "RU",
    "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.amocrm.ru/api/v4/account"
        }
    },
    "_embedded": {
        "amojo_rights": {
            "can_direct": true,
            "can_create_groups": true
        },
        "users_groups": [
            {
                "id": 0,
                "name": "Отдел продаж",
                "uuid": null
            }
        ],
        "task_types": [
            {
                "id": 1,
                "name": "Связаться",
                "color": null,
                "icon_id": null,
                "code": "FOLLOW_UP"
            },
            {
                "id": 2,
                "name": "Встреча",
                "color": null,
                "icon_id": null,
                "code": "MEETING"
            }
        ],
        "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"
        }
    }
}