АККАУНТ

Метод API

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

URL метода

GET /api/v2/account

Параметры

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

Значения для GET параметра

Возможные значения GET параметра with. Указывать можно более одного значения, через “,”.

Пример: https://example.amocrm.ru/api/v2/account?with=pipelines,groups,note_types,task_types

https://example.amocrm.ru/api/v2/account?with=users&free_users=Y по такому запросу можно получить всех пользователей, в том числе бесплатных.

Значение Описание
custom_fields Вернёт информацию по всем дополнительным полям в аккаунте
users Вернёт информацию по всем пользователям в аккаунте
pipelines Вернёт информацию по всем цифровым воронкам в аккаунте
groups Вернёт информацию по всем группам пользователей в аккаунте
note_types Вернёт информацию по всем типам дополнительных полей в аккаунте
task_types Вернёт информацию по всем типам задач в аккаунте

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

Параметр Тип Описание
id int Уникальный идентификатор аккаунта
name string Название аккаунта
subdomain string Уникальный субдомен данного аккаунта
currency string Валюта аккаунта (используемая при работе с бюджетом сделок). Не связано с биллинговой информацией самого аккаунта.
timezone string Временная зона
timezone_offset string Cмещение временной зоны
language string Язык аккаунта (ru – русский, en – английский)
date_pattern array Формат даты (описание формата см. здесь)
date_pattern/date string Дата, формат зависит от выбранного формата в аккаунте
date_pattern/time string Время, формат зависит от выбранного формата в аккаунте
date_pattern/date_time string Дата и время, формат зависит от выбранного формата в аккаунте
date_pattern/time_full string Время с точностью до секунды, формат зависит от выбранного формата в аккаунте
current_user int id текущего пользователя
users array Список пользователей аккаунта с их правами
users/id int Уникальный идентификатор пользователя
users/name string Имя пользователя
users/login string Логин пользователя
users/language string Настройки языка пользователя
users/phone_number string Номер телефона пользователя
users/group_id int id группы, в которой состоит пользователь
users/is_active bool Активна учётная запись пользователя или нет, если нет, то доступ будет закрыт
users/is_free bool Является ли учётная запись пользователя бесплатной
users/is_admin bool Наличие прав администратора
users/rights array Права пользователя (описание формата см. здесь)
users/rights/mail string Доступ к корпоративной почте
users/rights/incoming_leads string Доступ к “неразобранному”
users/rights/catalogs string Права пользователя на создание/редактирование каталогов и их элементов
users/rights/lead_add string Права пользователя на добавление новых сделок
users/rights/lead_view string Права пользователя на просмотра существующих сделок
users/rights/lead_edit string Права пользователя на редактирование существующих сделок
users/rights/lead_delete string Права пользователя на удаление существующих сделок
users/rights/lead_export string Права пользователя на экспорт сделок
users/rights/contact_add string Права пользователя на добавление новых контактов
users/rights/contact_view string Права пользователя на просмотр существующих контактов
users/rights/contact_edit string Права пользователя на редактирование существующих контактов
users/rights/contact_delete string Права пользователя на удаление существующих контактов
users/rights/contact_export string Права пользователя на экспорт контактов
users/rights/company_add string Права пользователя на добавление новых компаний
users/rights/company_view string Права пользователя на просмотр существующих компаний
users/rights/company_edit string Права пользователя на редактирование существующих компаний
users/rights/company_delete string Права пользователя на удаление существующих компаний
users/rights/company_export string Права пользователя на экспорт существующих компаний
custom_fields array Дополнительные поля для разных сущностей.
custom_fields/contacts array Дополнительные поля контактов
custom_fields/leads array Дополнительные поля сделок
custom_fields/companies array Дополнительные поля компаний
custom_fields/customers array Дополнительные поля покупателей
custom_fields/contacts/id int id дополнительного поля контакта (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/name string Имя дополнительного поля (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/field_type int Тип дополнительного поля (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/sort int Порядковый номер при отображении (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/is_multiple bool Обозначение, отвечающие за то является ли доп. поле списком или нет
custom_fields/contacts/is_system bool Является ли доп. поле системным
custom_fields/contacts/is_editable bool Можно ли редактировать поле
custom_fields/contacts/enums array Значения списка, существует в случае, если значение is_multiple равно истине
custom_fields/contacts/enums/id int id значения списка дополнительного поля
custom_fields/contacts/enums/value string Значение списка дополнительного поля
note_types array Список используемых в системе типов примечаний (подробное описание типов см. здесь)
note_types/id int Уникальный идентификатор примечания
note_types/name string Название примечания
note_types/code string Код примечания
note_types/editable bool Существует ли возможность редактирования примечания
task_types array Типы задач доступных для данного аккаунта
task_types/id int Уникальный идентификатор задачи
task_types/name string Название задачи
pipelines array Цифровые воронки имеющиеся на аккаунте
pipelines/id int Уникальный идентификатор воронки
pipelines/name string Название воронки
pipelines/sort int Порядковый номер воронки при отображении
pipelines/is_main bool Является ли воронка “главной”
pipelines/statuses array Этапы цифровой воронки
pipelines/statuses/id int Уникальный идентификатор этапа
pipelines/statuses/name string Название этапа
pipelines/statuses/sort int Порядковый номер этапа при отображении
pipelines/statuses/color string Цвет этапа (подробнее см. здесь)
pipelines/statuses/editable bool Есть ли возможность изменить или удалить этот этап

Формат даты

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

Значения прав пользователя

Код Описание
A Разрешено
M Разрешено только, если пользователь является ответственным
D Запрещено
G Разрешено только, если пользователь состоит в соответствующей группе

Response Headeres содержит следующие заголовки:

  • Content-Type:application/hal+json
  • Runtime-Timestamp:1508320306

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

{
	id: 13667499,
	name: "your_account_name",
	subdomain: "your_subdomain",
	currency: "RUB",
	timezone: "Europe/Moscow",
	timezone_offset: "+03:00",
	language: "ru",
	date_pattern: {
		date: "d.m.Y",
		time: "H:i",
		date_time: "d.m.Y H:i",
		time_full: "H:i:s"
	},
	current_user: 504141,
	_embedded: {
		users: {
			504141: {
				id: 504141,
				name: "Владимир",
				last_name: "",
				login: "example@example.com",
				language: "ru",
				group_id: 0,
				is_active: true,
				is_free: false,
				is_admin: true,
				rights: {
					mail: "A",
					incoming_leads: "A",
					catalogs: "A",
					lead_add: "A",
					lead_view: "A",
					lead_edit: "A",
					lead_delete: "A",
					lead_export: "A",
					contact_add: "A",
					contact_view: "A",
					contact_edit: "A",
					contact_delete: "A",
					contact_export: "A",
					company_add: "A",
					company_view: "A",
					company_edit: "A",
					company_delete: "A",
					company_export: "A"
				}
			}
		},
		custom_fields: {
			contacts: [{
					id: 4396817,
					name: "Должность",
					field_type: 1,
					sort: 2,
					is_multiple: false,
					is_system: true,
					is_editable: true
				},
				{
					id: 4396818,
					name: "Телефон",
					field_type: 8,
					sort: 4,
					is_multiple: true,
					is_system: true,
					is_editable: true,
					enums: [{
							id: 3685087,
							value: "WORK"
						},
						{
							id: 3685088,
							value: "WORKDD"
						},
						{
							id: 3685089,
							value: "MOB"
						},
						{
							id: 3685090,
							value: "FAX"
						},
						{
							id: 3685091,
							value: "HOME"
						},
						{
							id: 3685092,
							value: "OTHER"
						}
					]
				},
				{
					id: 4396819,
					name: "Email",
					field_type: 8,
					sort: 6,
					is_multiple: true,
					is_system: true,
					is_editable: true,
					enums: [{
							id: 3685093,
							value: "WORK"
						},
						{
							id: 3685094,
							value: "PRIV"
						},
						{
							id: 3685095,
							value: "OTHER"
						}
					]
				},
				{
					id: 4396821,
					name: "Мгн. сообщения",
					field_type: 8,
					sort: 10,
					is_multiple: true,
					is_system: true,
					is_editable: true,
					enums: [{
							id: 3685096,
							value: "SKYPE"
						},
						{
							id: 3685097,
							value: "ICQ"
						},
						{
							id: 3685098,
							value: "JABBER"
						},
						{
							id: 3685099,
							value: "GTALK"
						},
						{
							id: 3685100,
							value: "MSN"
						},
						{
							id: 3685101,
							value: "OTHER"
						}
					]
				}
			],
			leads: [],
			companies: [{
					id: 4396818,
					name: "Телефон",
					field_type: 8,
					sort: 4,
					is_multiple: true,
					is_system: true,
					is_editable: true,
					enums: [{
							id: 3685087,
							value: "WORK"
						},
						{
							id: 3685088,
							value: "WORKDD"
						},
						{
							id: 3685089,
							value: "MOB"
						},
						{
							id: 3685090,
							value: "FAX"
						},
						{
							id: 3685091,
							value: "HOME"
						},
						{
							id: 3685092,
							value: "OTHER"
						}
					]
				},
				{
					id: 4396819,
					name: "Email",
					field_type: 8,
					sort: 6,
					is_multiple: true,
					is_system: true,
					is_editable: true,
					enums: [{
							id: 3685093,
							value: "WORK"
						},
						{
							id: 3685094,
							value: "PRIV"
						},
						{
							id: 3685095,
							value: "OTHER"
						}
					]
				},
				{
					id: 4396820,
					name: "Web",
					field_type: 7,
					sort: 8,
					is_multiple: false,
					is_system: true,
					is_editable: true
				},
				{
					id: 4396822,
					name: "Адрес",
					field_type: 9,
					sort: 12,
					is_multiple: false,
					is_system: true,
					is_editable: true
				}
			],
			customers: []
		},
		note_types: [{
				id: 1,
				name: "",
				code: "DEAL_CREATED",
				editable: "N"
			},
			{
				id: 2,
				name: "",
				code: "CONTACT_CREATED",
				editable: "N"
			},
			{
				id: 3,
				name: "",
				code: "DEAL_STATUS_CHANGED",
				editable: "N"
			},
			{
				id: 4,
				name: "",
				code: "COMMON",
				editable: "Y"
			},
			{
				id: 5,
				name: "",
				code: "ATTACHEMENT",
				editable: "N"
			},
			{
				id: 6,
				name: "",
				code: "CALL",
				editable: "N"
			},
			{
				id: 7,
				name: "",
				code: "MAIL_MESSAGE",
				editable: "N"
			},
			{
				id: 8,
				name: "",
				code: "MAIL_MESSAGE_ATTACHMENT",
				editable: "N"
			},
			{
				id: 9,
				name: "",
				code: "EXTERNAL_ATTACH",
				editable: "N"
			},
			{
				id: 10,
				name: "",
				code: "CALL_IN",
				editable: "N"
			},
			{
				id: 11,
				name: "",
				code: "CALL_OUT",
				editable: "N"
			},
			{
				id: 12,
				name: "",
				code: "COMPANY_CREATED",
				editable: "N"
			},
			{
				id: 13,
				name: "",
				code: "TASK_RESULT",
				editable: "N"
			},
			{
				id: 17,
				name: "",
				code: "CHAT",
				editable: "N"
			},
			{
				id: 99,
				name: "",
				code: "MAX_SYSTEM",
				editable: "N"
			},
			{
				id: 101,
				name: "Ссылка",
				code: "DROPBOX",
				editable: "N"
			},
			{
				id: 102,
				name: "Входящее",
				code: "SMS_IN",
				editable: "N"
			},
			{
				id: 103,
				name: "Исходящее",
				code: "SMS_OUT",
				editable: "N"
			}
		],
		groups: [],
		task_types: [{
				id: 1,
				name: "Связаться с клиентом"
			},
			{
				id: 1,
				name: "Звонок"
			},
			{
				id: 2,
				name: "Встреча"
			},
			{
				id: 3,
				name: "Письмо"
			}
		],
		pipelines: {
			10104: {
				id: 10104,
				name: "Воронка",
				sort: 1,
				is_main: true,
				statuses: {
					142: {
						id: 142,
						name: "Успешно реализовано",
						color: "#CCFF66",
						sort: 10000,
						editable: "N"
					},
					143: {
						id: 143,
						name: "Закрыто и не реализовано",
						color: "#D5D8DB",
						sort: 11000,
						editable: "N"
					},
					13667501: {
						id: 13667501,
						name: "Первичный контакт",
						sort: 10,
						color: "#99ccff",
						editable: "Y"
					},
					13667502: {
						id: 13667502,
						name: "Переговоры",
						sort: 20,
						color: "#ffff99",
						editable: "Y"
					},
					13667503: {
						id: 13667503,
						name: "Принимают решение",
						sort: 30,
						color: "#ffcc66",
						editable: "Y"
					},
					13667504: {
						id: 13667504,
						name: "Согласование договора",
						sort: 40,
						color: "#ffcccc",
						editable: "Y"
					}
				}
			}
		}
	}
}

Пример запроса


/* Для начала нам необходимо инициализировать данные, необходимые для составления запроса. */
$subdomain = 'test'; #Наш аккаунт - поддомен

#Формируем ссылку для запроса
$link = 'https://' . $subdomain . '.amocrm.ru/api/v2/account';

/*
Нам необходимо инициировать запрос к серверу. Воспользуемся библиотекой cURL (поставляется в составе PHP).
Вы также можете использовать и кроссплатформенную программу cURL, если вы не программируете на PHP.
*/

$curl = curl_init(); #Сохраняем дескриптор сеанса cURL
#Устанавливаем необходимые опции для сеанса cURL
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_USERAGENT, 'amoCRM-API-client/1.0');
curl_setopt($curl, CURLOPT_URL, $link);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_COOKIEFILE, dirname(__FILE__) . '/cookie.txt'); #PHP>5.3.6 dirname(__FILE__) -> __DIR__
curl_setopt($curl, CURLOPT_COOKIEJAR, dirname(__FILE__) . '/cookie.txt'); #PHP>5.3.6 dirname(__FILE__) -> __DIR__
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
$out = curl_exec($curl); #Инициируем запрос к API и сохраняем ответ в переменную
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

/*
Теперь мы можем обработать ответ, полученный от сервера.
Это пример. Вы можете обработать данные своим способом.
*/
$code = (int) $code;
$errors = array(
	301 => 'Moved permanently',
	400 => 'Bad request',
	401 => 'Unauthorized',
	403 => 'Forbidden',
	404 => 'Not found',
	500 => 'Internal server error',
	502 => 'Bad gateway',
	503 => 'Service unavailable'
);

try { #Если код ответа не равен 200 или 204 - возвращаем сообщение об ошибке
	if ($code != 200 && $code != 204) {
		throw new Exception(isset($errors[$code]) ? $errors[$code] : 'Undescribed error', $code);
	}
} catch (Exception $E) {
    die('Ошибка: ' . $E->getMessage() . PHP_EOL . 'Код ошибки: ' . $E->getCode());
}

/*
Данные получаем в формате JSON, поэтому, для получения читаемых данных,
нам придётся перевести ответ в формат, понятный PHP
*/
$Response = json_decode($out, true);
$Response = $Response[0];

Смотрите также

КОДЫ ОШИБОК API