GET /api/v4/account
Метод позволяет получить необходимую информацию по аккаунту, например: ID, название, справочник типов задач, группы пользователей и другие параметры.
Метод доступен всем пользователям аккаунта.
| Параметр | Тип данных | Описание |
|---|---|---|
| with | string | Данный параметр принимает строку, в том числе из нескольких значений, указанных через запятую. Данный метод поддерживает следующие параметры. |
Content-Type: application/hal+json
Content-Type: application/problem+json
| Код ответа | Условие |
|---|---|
| 200 | Запрос выполнен успешно |
| 401 | Пользователь не авторизован |
Метод возвращает модель данных аккаунта, рассмотрим ниже свойства.
| Параметр | Тип данных | Описание |
|---|---|---|
| id | int | ID аккаунта |
| name | string | Название аккаунта |
| subdomain | string | Субдомен аккаунта |
| 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 – Фамилия, Имя) |
| amojo_id | string | Требуется GET параметр with. Уникальный идентификатор аккаунта для работы с сервисом чатов amoJo |
| version | int | Требуется GET параметр with. Текущая версия amoCRM |
| drive_url | string | Требуется GET параметр with. Адрес сервиса файлов для конкретного аккаунта |
| is_api_filter_enabled | bool | Требуется GET параметр with. Включена ли API фильтрация для аккаунта |
| entity_names | object | Требуется GET параметр with. Настройки названия сущностей |
| invoices_settings | object | Требуется GET параметр with. Настройки счетов-покупок |
| invoices_settings[lang] | string | Требуется GET параметр with. Язык счетов-покупок и PayWall. |
| invoices_settings[invoices_catalog_id] | int | Требуется GET параметр with. ID списка счетов-покупок |
| _embedded[amojo_rights] | object | Требуется GET параметр with. Объект настроек чатов |
| _embedded[amojo_rights][can_direct] | object | Требуется GET параметр with. Доступны ли внутренние чаты |
| _embedded[amojo_rights][can_create_groups] | object | Требуется GET параметр with. Доступна ли возможность создавать групповые чаты |
| _embedded[users_groups] | array | Требуется GET параметр with. Массив объектов групп пользователей аккаунта |
| _embedded[users_groups][0][id] | int | Требуется GET параметр with. ID группы пользователей |
| _embedded[users_groups][0][name] | string | Требуется GET параметр with. Название группы пользователей |
| _embedded[task_types] | array | Требуется GET параметр with. Типы задач, доступные в аккаунте |
| _embedded[task_types][0][id] | int | Требуется GET параметр with. ID типа задач |
| _embedded[task_types][0][name] | string | Требуется GET параметр with. Название типа задач |
| _embedded[task_types][0][color] | string | Требуется GET параметр with. Цвет типа задач |
| _embedded[task_types][0][icon_id] | int | Требуется GET параметр with. ID иконки типа задач |
| _embedded[task_types][0][code] | string | Требуется GET параметр with. Код типа задач |
| _embedded[datetime_settings] | object | Требуется GET параметр with. Настройки и форматы даты и времени в аккаунте |
{
"id": 1231414,
"name": "example",
"subdomain": "example",
"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,
"is_api_filter_enabled": true,
"contact_name_display_order": 1,
"amojo_id": "f3c6340d-410e-4ad1-9f7e-c5e663599909",
"uuid": "824f3a59-6154-4edf-ba90-0b5593715d07",
"drive_url": "https://drive-b.amocrm.ru"
"version": 16,
"entity_names": {
"leads": {
"ru": {
"gender": "m",
"plural_form": {
"dative": "клиентам",
"default": "клиенты",
"genitive": "клиентов",
"accusative": "клиентов",
"instrumental": "клиентами",
"prepositional": "клиентах"
},
"singular_form": {
"dative": "клиенту",
"default": "клиент",
"genitive": "клиента",
"accusative": "клиента",
"instrumental": "клиентом",
"prepositional": "клиенте"
}
},
"en": {
"singular_form": {
"default": "lead"
},
"plural_form": {
"default": "leads"
},
"gender": "f"
},
"es": {
"singular_form": {
"default": "acuerdo"
},
"plural_form": {
"default": "acuerdos"
},
"gender": "m"
}
}
},
"_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"
}
}
}| Параметр | Описание |
|---|---|
| amojo_id | Добавляет в ответ ID аккаунта в сервисе чатов |
| amojo_rights | Добавляет в ответ информацию о доступности функционала создания групповых и использования директ чатов пользователями |
| users_groups | Добавляет в ответ информацию о доступных группах пользователей аккаунта |
| task_types | Добавляет в ответ информацию о доступных типах задач в аккаунте |
| version | Добавляет в ответ информацию о текущей версии amoCRM |
| entity_names | Добавляет в ответ названия сущностей с их переводами и формами чисел |
| datetime_settings | Добавляет в ответ информацию о текущих настройках форматов даты и времени аккаунта |
| drive_url | Добавляет в ответ адрес сервиса файлов для запрашиваемого аккаунта |
| is_api_filter_enabled | Добавляет в ответ флаг, включена ли Альфа-фильтрация для аккаунта |
| invoices_settings | Добавляет в ответ информацию о настройки счетов-покупок |