API Reference

Клиент

class amocrm.client.AmoCRM(subdomain, oauth)[исходный код]

Базовые классы: object

Клиент AmoCRM REST API.

Предоставляет доступ к ресурсам сделок, контактов, компаний и воронок через свойства leads, contacts, companies, pipelines. Автоматически обновляет токен доступа при получении ответа 401 Unauthorized.

Параметры:

subdomain (str)
oauth (OAuthConfig)

__init__(subdomain, oauth)[исходный код]

Инициализировать клиент, загрузив токены из хранилища.

Параметры:

subdomain (str) – Поддомен аккаунта AmoCRM (например, "mycompany").
oauth (OAuthConfig) – Конфигурация OAuth с реквизитами интеграции и хранилищем токенов. Токены загружаются из oauth.storage.load() при создании клиента.

Тип результата:

None

classmethod from_code(subdomain, code, oauth)[исходный код]

Обменять код авторизации на токены, сохранить их и вернуть новый клиент.

Параметры:

subdomain (str) – Поддомен аккаунта AmoCRM.
code (str) – Одноразовый код авторизации из callback-запроса OAuth 2.0.
oauth (OAuthConfig) – Конфигурация OAuth с реквизитами интеграции и хранилищем токенов.

Результат:

Инициализированный экземпляр AmoCRM.

Исключение:

AmoCRMTokenRefreshError – Если обмен кода на токены завершился ошибкой.

Тип результата:

AmoCRM

property leads: LeadsResource: Ресурс для работы со сделками.

property pipelines: PipelinesResource: Ресурс для работы с воронками и их статусами.

property contacts: ContactsResource: Ресурс для работы с контактами.

property companies: CompaniesResource: Ресурс для работы с компаниями.

Авторизация

class amocrm.auth.TokenStorage(*args, **kwargs)[исходный код]

Базовые классы: Protocol

Протокол хранилища токенов OAuth.

Реализации должны обеспечивать сохранение и загрузку пары access_token / refresh_token из произвольного хранилища (база данных, файл, переменные окружения и т.д.).

save(access_token, refresh_token)[исходный код]

Сохранить токены в хранилище.

Параметры:

access_token (str) – Токен доступа OAuth 2.0.
refresh_token (str) – Токен обновления OAuth 2.0.

Тип результата:

None

load()[исходный код]

Загрузить токены из хранилища.

Результат:: Кортеж (access_token, refresh_token).
Тип результата:: tuple[str, str]

__init__(*args, **kwargs)

class amocrm.auth.OAuthConfig(*, client_id, client_secret, redirect_uri, storage)[исходный код]

Базовые классы: object

Конфигурация OAuth 2.0 для подключения к AmoCRM.

Переменные:

client_id (str) – Идентификатор интеграции из личного кабинета AmoCRM.
client_secret (str) – Секрет интеграции.
redirect_uri (str) – URI перенаправления, указанный при создании интеграции.
storage (amocrm.auth.TokenStorage) – Хранилище токенов, реализующее протокол TokenStorage.

Параметры:

client_id (str)
client_secret (str)
redirect_uri (str)
storage (TokenStorage)

client_id: str

client_secret: str

redirect_uri: str

storage: TokenStorage

__init__(*, client_id, client_secret, redirect_uri, storage)

Параметры:

client_id (str)
client_secret (str)
redirect_uri (str)
storage (TokenStorage)

Тип результата:

None

class amocrm.auth.DjangoTokenStorage(instance)[исходный код]

Базовые классы: object

Хранилище токенов на основе экземпляра модели Django.

Токены сохраняются в полях access_token и refresh_token переданного объекта и сохраняются вызовом instance.save().

Параметры:: instance (Any)

__init__(instance)[исходный код]

Параметры:: instance (Any) – Экземпляр модели Django с полями access_token и refresh_token.
Тип результата:: None

save(access_token, refresh_token)[исходный код]

Сохранить токены в модель Django и вызвать instance.save().

Параметры:

access_token (str) – Токен доступа OAuth 2.0.
refresh_token (str) – Токен обновления OAuth 2.0.

Тип результата:

None

load()[исходный код]

Загрузить токены из полей модели Django.

Результат:: Кортеж (access_token, refresh_token).
Тип результата:: tuple[str, str]

Менеджер (синглтон)

amocrm.manager.exchange_code(subdomain, code, oauth)[исходный код]

Обменять код авторизации на токены и инициализировать глобальный клиент.

После успешного обмена глобальный клиент готов к работе; повторный вызов get_client() вернёт уже созданный экземпляр.

Параметры:

subdomain (str) – Поддомен аккаунта AmoCRM (например, "mycompany").
code (str) – Одноразовый код авторизации из callback-запроса OAuth 2.0.
oauth (OAuthConfig) – Конфигурация OAuth с реквизитами интеграции и хранилищем токенов.

Исключение:

AmoCRMTokenRefreshError – Если обмен кода на токены завершился ошибкой.

Тип результата:

None

amocrm.manager.get_client(subdomain, oauth)[исходный код]

Вернуть глобальный клиент, создав его из хранилища при первом вызове.

При первом вызове создаёт AmoCRM, загружая токены из oauth.storage. Последующие вызовы возвращают тот же экземпляр.

Параметры:

subdomain (str) – Поддомен аккаунта AmoCRM.
oauth (OAuthConfig) – Конфигурация OAuth с реквизитами интеграции и хранилищем токенов.

Результат:

Инициализированный экземпляр AmoCRM.

Тип результата:

AmoCRM

amocrm.manager.reset()[исходный код]

Сбросить глобальный клиент (полезно в тестах).

Тип результата:: None

Исключения

exception amocrm.exceptions.AmoCRMError[исходный код]

Базовые классы: Exception

Базовый класс исключений SDK.

exception amocrm.exceptions.AmoCRMAPIError(status_code, body)[исходный код]

Базовые классы: AmoCRMError

Исключение при ошибке API AmoCRM (статус не 2xx).

Переменные:

status_code – HTTP-статус ответа.
body – Тело ответа в виде строки.

Параметры:

status_code (int)
body (str)

Тип результата:

None

__init__(status_code, body)[исходный код]

Параметры:

status_code (int) – HTTP-статус ответа API.
body (str) – Тело ответа API в виде строки.

Тип результата:

None

exception amocrm.exceptions.AmoCRMTokenRefreshError[исходный код]

Базовые классы: AmoCRMError

Исключение при неудачном обновлении токена доступа.

exception amocrm.exceptions.AmoCRMNotConfiguredError[исходный код]

Базовые классы: AmoCRMError

Исключение при использовании менеджера до его настройки.

Ресурсы

Сделки

class amocrm.resources.leads.LeadsResource(client)[исходный код]

Базовые классы: object

Ресурс для работы со сделками AmoCRM (/api/v4/leads).

Параметры:: client (AmoCRM)

__init__(client)[исходный код]

Параметры:: client (AmoCRM) – Экземпляр клиента AmoCRM.
Тип результата:: None

list(*, page=None, limit=None, query=None, filter=None, order=None, with_=None)[исходный код]

Получить список сделок с пагинацией и фильтрами.

Параметры:

page (int | None) – Номер страницы (начиная с 1).
limit (int | None) – Количество сделок на странице (максимум 250).
query (str | None) – Строка полнотекстового поиска.
filter (dict[str, Any] | None) – Словарь фильтров вида {"field": "value"}; ключи преобразуются в параметры filter[field]=value.
order (dict[str, str] | None) – Словарь сортировки вида {"field": "asc"|"desc"}; ключи преобразуются в параметры order[field]=asc.
with – Список дополнительных данных для подгрузки (например, ["contacts", "companies"]).
with_ (list[str] | None)

Результат:

Список объектов Lead.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

list[Lead]

get(lead_id, *, with_=None)[исходный код]

Получить сделку по идентификатору.

Параметры:

lead_id (int) – Идентификатор сделки.
with – Список дополнительных данных для подгрузки.
with_ (list[str] | None)

Результат:

Объект Lead.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Lead

create(leads)[исходный код]

Создать одну или несколько сделок.

Параметры:: leads (list[Lead]) – Список сделок для создания.
Результат:: Список созданных сделок с заполненными идентификаторами.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Lead]

update(leads)[исходный код]

Обновить одну или несколько сделок (каждая должна содержать id).

Параметры:: leads (list[Lead]) – Список сделок для обновления. Каждая сделка обязана содержать заполненное поле id.
Результат:: Список обновлённых сделок.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Lead]

update_one(lead_id, data)[исходный код]

Обновить одну сделку по идентификатору.

Параметры:

lead_id (int) – Идентификатор сделки.
data (Lead) – Объект с обновляемыми полями.

Результат:

Обновлённый объект Lead.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Lead

create_complex(leads)[исходный код]

Сложное создание сделок со связанными сущностями.

Использует эндпоинт POST /api/v4/leads/complex, позволяющий одновременно создавать сделки вместе с контактами и компаниями.

Параметры:: leads (list[Lead]) – Список сделок для создания.
Результат:: Список созданных сделок с заполненными идентификаторами.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Lead]

Контакты

class amocrm.resources.contacts.ContactsResource(client)[исходный код]

Базовые классы: object

Ресурс для работы с контактами AmoCRM (/api/v4/contacts).

Параметры:: client (AmoCRM)

__init__(client)[исходный код]

Параметры:: client (AmoCRM) – Экземпляр клиента AmoCRM.
Тип результата:: None

list(*, page=None, limit=None, query=None, filter=None, order=None, with_=None)[исходный код]

Получить список контактов с пагинацией и фильтрами.

Параметры:

page (int | None) – Номер страницы (начиная с 1).
limit (int | None) – Количество контактов на странице (максимум 250).
query (str | None) – Строка полнотекстового поиска.
filter (dict[str, Any] | None) – Словарь фильтров вида {"field": "value"}; ключи преобразуются в параметры filter[field]=value.
order (dict[str, str] | None) – Словарь сортировки вида {"field": "asc"|"desc"}; ключи преобразуются в параметры order[field]=asc.
with – Список дополнительных данных для подгрузки.
with_ (list[str] | None)

Результат:

Список объектов Contact.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

list[Contact]

get(contact_id, *, with_=None)[исходный код]

Получить контакт по идентификатору.

Параметры:

contact_id (int) – Идентификатор контакта.
with – Список дополнительных данных для подгрузки.
with_ (list[str] | None)

Результат:

Объект Contact.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Contact

create(contacts)[исходный код]

Создать один или несколько контактов.

Параметры:: contacts (list[Contact]) – Список контактов для создания.
Результат:: Список созданных контактов с заполненными идентификаторами.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Contact]

update(contacts)[исходный код]

Обновить один или несколько контактов (каждый должен содержать id).

Параметры:: contacts (list[Contact]) – Список контактов для обновления. Каждый контакт обязан содержать заполненное поле id.
Результат:: Список обновлённых контактов.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Contact]

update_one(contact_id, data)[исходный код]

Обновить один контакт по идентификатору.

Параметры:

contact_id (int) – Идентификатор контакта.
data (Contact) – Объект с обновляемыми полями.

Результат:

Обновлённый объект Contact.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Contact

Компании

class amocrm.resources.companies.CompaniesResource(client)[исходный код]

Базовые классы: object

Ресурс для работы с компаниями AmoCRM (/api/v4/companies).

Параметры:: client (AmoCRM)

__init__(client)[исходный код]

Параметры:: client (AmoCRM) – Экземпляр клиента AmoCRM.
Тип результата:: None

list(*, page=None, limit=None, query=None, filter=None, order=None, with_=None)[исходный код]

Получить список компаний с пагинацией и фильтрами.

Параметры:

page (int | None) – Номер страницы (начиная с 1).
limit (int | None) – Количество компаний на странице (максимум 250).
query (str | None) – Строка полнотекстового поиска.
filter (dict[str, Any] | None) – Словарь фильтров вида {"field": "value"}; ключи преобразуются в параметры filter[field]=value.
order (dict[str, str] | None) – Словарь сортировки вида {"field": "asc"|"desc"}; ключи преобразуются в параметры order[field]=asc.
with – Список дополнительных данных для подгрузки.
with_ (list[str] | None)

Результат:

Список объектов Company.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

list[Company]

get(company_id, *, with_=None)[исходный код]

Получить компанию по идентификатору.

Параметры:

company_id (int) – Идентификатор компании.
with – Список дополнительных данных для подгрузки.
with_ (list[str] | None)

Результат:

Объект Company.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Company

create(companies)[исходный код]

Создать одну или несколько компаний.

Параметры:: companies (list[Company]) – Список компаний для создания.
Результат:: Список созданных компаний с заполненными идентификаторами.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Company]

update(companies)[исходный код]

Обновить одну или несколько компаний (каждая должна содержать id).

Параметры:: companies (list[Company]) – Список компаний для обновления. Каждая компания обязана содержать заполненное поле id.
Результат:: Список обновлённых компаний.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Company]

update_one(company_id, data)[исходный код]

Обновить одну компанию по идентификатору.

Параметры:

company_id (int) – Идентификатор компании.
data (Company) – Объект с обновляемыми полями.

Результат:

Обновлённый объект Company.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Company

Воронки

class amocrm.resources.pipelines.PipelinesResource(client)[исходный код]

Базовые классы: object

Ресурс для работы с воронками и статусами AmoCRM.

Эндпоинт: /api/v4/leads/pipelines.

Параметры:: client (AmoCRM)

__init__(client)[исходный код]

Параметры:: client (AmoCRM) – Экземпляр клиента AmoCRM.
Тип результата:: None

list()[исходный код]

Получить список всех воронок аккаунта.

Результат:: Список объектов Pipeline.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Pipeline]

get(pipeline_id)[исходный код]

Получить воронку по идентификатору.

Параметры:: pipeline_id (int) – Идентификатор воронки.
Результат:: Объект Pipeline.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: Pipeline

create(pipelines)[исходный код]

Создать одну или несколько воронок.

Параметры:: pipelines (list[Pipeline]) – Список воронок для создания.
Результат:: Список созданных воронок с заполненными идентификаторами.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: list[Pipeline]

update(pipeline_id, data)[исходный код]

Обновить воронку по идентификатору.

Параметры:

pipeline_id (int) – Идентификатор воронки.
data (Pipeline) – Объект с обновляемыми полями.

Результат:

Обновлённый объект Pipeline.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

Pipeline

delete(pipeline_id)[исходный код]

Удалить воронку по идентификатору.

Параметры:: pipeline_id (int) – Идентификатор воронки.
Исключение:: AmoCRMAPIError – При ошибке API (статус не 2xx).
Тип результата:: None

list_statuses(pipeline_id, *, with_descriptions=False)[исходный код]

Получить список статусов воронки.

Параметры:

pipeline_id (int) – Идентификатор воронки.
with_descriptions (bool) – Если True, подгружает описания уровней зрелости для каждого статуса.

Результат:

Список объектов PipelineStatus.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

list[PipelineStatus]

get_status(pipeline_id, status_id, *, with_descriptions=False)[исходный код]

Получить статус воронки по идентификатору.

Параметры:

pipeline_id (int) – Идентификатор воронки.
status_id (int) – Идентификатор статуса.
with_descriptions (bool) – Если True, подгружает описания уровней зрелости.

Результат:

Объект PipelineStatus.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

PipelineStatus

create_statuses(pipeline_id, statuses)[исходный код]

Создать статусы в воронке.

Параметры:

pipeline_id (int) – Идентификатор воронки.
statuses (list[PipelineStatus]) – Список статусов для создания.

Результат:

Список созданных статусов с заполненными идентификаторами.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

list[PipelineStatus]

update_status(pipeline_id, status_id, data)[исходный код]

Обновить статус воронки.

Параметры:

pipeline_id (int) – Идентификатор воронки.
status_id (int) – Идентификатор статуса.
data (PipelineStatus) – Объект с обновляемыми полями.

Результат:

Обновлённый объект PipelineStatus.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

PipelineStatus

delete_status(pipeline_id, status_id)[исходный код]

Удалить статус воронки.

Параметры:

pipeline_id (int) – Идентификатор воронки.
status_id (int) – Идентификатор статуса.

Исключение:

AmoCRMAPIError – При ошибке API (статус не 2xx).

Тип результата:

None

Модели

Общие типы

class amocrm.models.common.Tag(*, id=None, name=None)[исходный код]

Базовые классы: object

Тег сущности AmoCRM.

Переменные:

id (int | None) – Идентификатор тега.
name (str | None) – Название тега.

Параметры:

id (int | None)
name (str | None)

id: int | None = None

name: str | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API.

Параметры:: data (dict[str, Any])
Тип результата:: Tag

to_dict()[исходный код]

Сериализовать в словарь, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None)

Параметры:

id (int | None)
name (str | None)

Тип результата:

None

class amocrm.models.common.CustomFieldValue(*, field_id, values=<factory>)[исходный код]

Базовые классы: object

Значение кастомного поля AmoCRM.

Переменные:

field_id (int) – Идентификатор кастомного поля.
values (list[dict[str, Any]]) – Список значений поля (каждое — словарь с ключами value и опционально enum_id / enum_code).

Параметры:

field_id (int)
values (list[dict[str, Any]])

field_id: int

values: list[dict[str, Any]]

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API.

Параметры:: data (dict[str, Any])
Тип результата:: CustomFieldValue

to_dict()[исходный код]

Сериализовать в словарь для отправки в API.

Тип результата:: dict[str, Any]

__init__(*, field_id, values=<factory>)

Параметры:

field_id (int)
values (list[dict[str, Any]])

Тип результата:

None

Сделки

class amocrm.models.leads.Lead(*, id=None, name=None, price=None, status_id=None, pipeline_id=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closed_at=None, closest_task_at=None, is_deleted=None, loss_reason_id=None, score=None, account_id=None, labor_cost=None, tags=None, custom_fields_values=None)[исходный код]

Базовые классы: object

DTO-модель сделки AmoCRM.

Переменные:

id (int | None) – Идентификатор сделки.
name (str | None) – Название сделки.
price (int | None) – Бюджет сделки.
status_id (int | None) – Идентификатор статуса воронки.
pipeline_id (int | None) – Идентификатор воронки.
responsible_user_id (int | None) – Идентификатор ответственного пользователя.
group_id (int | None) – Идентификатор группы пользователей.
created_by (int | None) – Идентификатор пользователя, создавшего сделку.
updated_by (int | None) – Идентификатор пользователя, обновившего сделку.
created_at (int | None) – Дата создания (Unix timestamp).
updated_at (int | None) – Дата последнего изменения (Unix timestamp).
closed_at (int | None) – Дата закрытия сделки (Unix timestamp).
closest_task_at (int | None) – Дата ближайшей задачи (Unix timestamp).
is_deleted (bool | None) – Признак удалённой сделки.
loss_reason_id (int | None) – Идентификатор причины закрытия (проигрыша).
score (int | None) – Оценка сделки.
account_id (int | None) – Идентификатор аккаунта AmoCRM.
labor_cost (int | None) – Затраченное время (в минутах).
tags (list[amocrm.models.common.Tag] | None) – Список тегов сделки.
custom_fields_values (list[amocrm.models.common.CustomFieldValue] | None) – Список значений кастомных полей.

Параметры:

id (int | None)
name (str | None)
price (int | None)
status_id (int | None)
pipeline_id (int | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closed_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
loss_reason_id (int | None)
score (int | None)
account_id (int | None)
labor_cost (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

id: int | None = None

name: str | None = None

price: int | None = None

status_id: int | None = None

pipeline_id: int | None = None

responsible_user_id: int | None = None

group_id: int | None = None

created_by: int | None = None

updated_by: int | None = None

created_at: int | None = None

updated_at: int | None = None

closed_at: int | None = None

closest_task_at: int | None = None

is_deleted: bool | None = None

loss_reason_id: int | None = None

score: int | None = None

account_id: int | None = None

labor_cost: int | None = None

tags: list[Tag] | None = None

custom_fields_values: list[CustomFieldValue] | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API AmoCRM.

Параметры:: data (dict[str, Any])
Тип результата:: Lead

to_dict()[исходный код]

Сериализовать в словарь для API, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None, price=None, status_id=None, pipeline_id=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closed_at=None, closest_task_at=None, is_deleted=None, loss_reason_id=None, score=None, account_id=None, labor_cost=None, tags=None, custom_fields_values=None)

Параметры:

id (int | None)
name (str | None)
price (int | None)
status_id (int | None)
pipeline_id (int | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closed_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
loss_reason_id (int | None)
score (int | None)
account_id (int | None)
labor_cost (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

Тип результата:

None

Контакты

class amocrm.models.contacts.Contact(*, id=None, name=None, first_name=None, last_name=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closest_task_at=None, is_deleted=None, account_id=None, tags=None, custom_fields_values=None)[исходный код]

Базовые классы: object

DTO-модель контакта AmoCRM.

Переменные:

id (int | None) – Идентификатор контакта.
name (str | None) – Полное имя контакта.
first_name (str | None) – Имя.
last_name (str | None) – Фамилия.
responsible_user_id (int | None) – Идентификатор ответственного пользователя.
group_id (int | None) – Идентификатор группы пользователей.
created_by (int | None) – Идентификатор пользователя, создавшего контакт.
updated_by (int | None) – Идентификатор пользователя, обновившего контакт.
created_at (int | None) – Дата создания (Unix timestamp).
updated_at (int | None) – Дата последнего изменения (Unix timestamp).
closest_task_at (int | None) – Дата ближайшей задачи (Unix timestamp).
is_deleted (bool | None) – Признак удалённого контакта.
account_id (int | None) – Идентификатор аккаунта AmoCRM.
tags (list[amocrm.models.common.Tag] | None) – Список тегов контакта.
custom_fields_values (list[amocrm.models.common.CustomFieldValue] | None) – Список значений кастомных полей.

Параметры:

id (int | None)
name (str | None)
first_name (str | None)
last_name (str | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
account_id (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

id: int | None = None

name: str | None = None

first_name: str | None = None

last_name: str | None = None

responsible_user_id: int | None = None

group_id: int | None = None

created_by: int | None = None

updated_by: int | None = None

created_at: int | None = None

updated_at: int | None = None

closest_task_at: int | None = None

is_deleted: bool | None = None

account_id: int | None = None

tags: list[Tag] | None = None

custom_fields_values: list[CustomFieldValue] | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API AmoCRM.

Параметры:: data (dict[str, Any])
Тип результата:: Contact

to_dict()[исходный код]

Сериализовать в словарь для API, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None, first_name=None, last_name=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closest_task_at=None, is_deleted=None, account_id=None, tags=None, custom_fields_values=None)

Параметры:

id (int | None)
name (str | None)
first_name (str | None)
last_name (str | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
account_id (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

Тип результата:

None

Компании

class amocrm.models.companies.Company(*, id=None, name=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closest_task_at=None, is_deleted=None, account_id=None, tags=None, custom_fields_values=None)[исходный код]

Базовые классы: object

DTO-модель компании AmoCRM.

Переменные:

id (int | None) – Идентификатор компании.
name (str | None) – Название компании.
responsible_user_id (int | None) – Идентификатор ответственного пользователя.
group_id (int | None) – Идентификатор группы пользователей.
created_by (int | None) – Идентификатор пользователя, создавшего компанию.
updated_by (int | None) – Идентификатор пользователя, обновившего компанию.
created_at (int | None) – Дата создания (Unix timestamp).
updated_at (int | None) – Дата последнего изменения (Unix timestamp).
closest_task_at (int | None) – Дата ближайшей задачи (Unix timestamp).
is_deleted (bool | None) – Признак удалённой компании.
account_id (int | None) – Идентификатор аккаунта AmoCRM.
tags (list[amocrm.models.common.Tag] | None) – Список тегов компании.
custom_fields_values (list[amocrm.models.common.CustomFieldValue] | None) – Список значений кастомных полей.

Параметры:

id (int | None)
name (str | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
account_id (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

id: int | None = None

name: str | None = None

responsible_user_id: int | None = None

group_id: int | None = None

created_by: int | None = None

updated_by: int | None = None

created_at: int | None = None

updated_at: int | None = None

closest_task_at: int | None = None

is_deleted: bool | None = None

account_id: int | None = None

tags: list[Tag] | None = None

custom_fields_values: list[CustomFieldValue] | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API AmoCRM.

Параметры:: data (dict[str, Any])
Тип результата:: Company

to_dict()[исходный код]

Сериализовать в словарь для API, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None, responsible_user_id=None, group_id=None, created_by=None, updated_by=None, created_at=None, updated_at=None, closest_task_at=None, is_deleted=None, account_id=None, tags=None, custom_fields_values=None)

Параметры:

id (int | None)
name (str | None)
responsible_user_id (int | None)
group_id (int | None)
created_by (int | None)
updated_by (int | None)
created_at (int | None)
updated_at (int | None)
closest_task_at (int | None)
is_deleted (bool | None)
account_id (int | None)
tags (list[Tag] | None)
custom_fields_values (list[CustomFieldValue] | None)

Тип результата:

None

Воронки и статусы

class amocrm.models.pipelines.StatusDescription(*, id=None, level=None, text=None)[исходный код]

Базовые классы: object

Описание уровня зрелости сделки в статусе воронки.

Переменные:

id (int | None) – Идентификатор описания.
level (str | None) – Уровень зрелости ("newbie", "candidate", "master").
text (str | None) – Текст описания.

Параметры:

id (int | None)
level (str | None)
text (str | None)

id: int | None = None

level: str | None = None

text: str | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API.

Параметры:: data (dict[str, Any])
Тип результата:: StatusDescription

to_dict()[исходный код]

Сериализовать в словарь, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, level=None, text=None)

Параметры:

id (int | None)
level (str | None)
text (str | None)

Тип результата:

None

class amocrm.models.pipelines.PipelineStatus(*, id=None, name=None, sort=None, is_editable=None, pipeline_id=None, color=None, type=None, account_id=None, descriptions=None)[исходный код]

Базовые классы: object

DTO-модель статуса воронки AmoCRM.

Переменные:

id (int | None) – Идентификатор статуса.
name (str | None) – Название статуса.
sort (int | None) – Порядок сортировки.
is_editable (bool | None) – Можно ли редактировать статус.
pipeline_id (int | None) – Идентификатор воронки, которой принадлежит статус.
color (str | None) – HEX-цвет статуса (например, "#fffeb2").
type (int | None) – Тип статуса (0 — обычный, 142 — успешно завершён, 143 — закрыт и не реализован).
account_id (int | None) – Идентификатор аккаунта AmoCRM.
descriptions (list[amocrm.models.pipelines.StatusDescription] | None) – Описания уровней зрелости сделок в этом статусе.

Параметры:

id (int | None)
name (str | None)
sort (int | None)
is_editable (bool | None)
pipeline_id (int | None)
color (str | None)
type (int | None)
account_id (int | None)
descriptions (list[StatusDescription] | None)

id: int | None = None

name: str | None = None

sort: int | None = None

is_editable: bool | None = None

pipeline_id: int | None = None

color: str | None = None

type: int | None = None

account_id: int | None = None

descriptions: list[StatusDescription] | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API.

Параметры:: data (dict[str, Any])
Тип результата:: PipelineStatus

to_dict()[исходный код]

Сериализовать в словарь для API, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None, sort=None, is_editable=None, pipeline_id=None, color=None, type=None, account_id=None, descriptions=None)

Параметры:

id (int | None)
name (str | None)
sort (int | None)
is_editable (bool | None)
pipeline_id (int | None)
color (str | None)
type (int | None)
account_id (int | None)
descriptions (list[StatusDescription] | None)

Тип результата:

None

class amocrm.models.pipelines.Pipeline(*, id=None, name=None, sort=None, is_main=None, is_unsorted_on=None, is_archive=None, account_id=None, statuses=None)[исходный код]

Базовые классы: object

DTO-модель воронки продаж AmoCRM.

Переменные:

id (int | None) – Идентификатор воронки.
name (str | None) – Название воронки.
sort (int | None) – Порядок сортировки.
is_main (bool | None) – Является ли воронка основной.
is_unsorted_on (bool | None) – Включён ли неразобранный раздел.
is_archive (bool | None) – Находится ли воронка в архиве.
account_id (int | None) – Идентификатор аккаунта AmoCRM.
statuses (list[amocrm.models.pipelines.PipelineStatus] | None) – Список статусов воронки.

Параметры:

id (int | None)
name (str | None)
sort (int | None)
is_main (bool | None)
is_unsorted_on (bool | None)
is_archive (bool | None)
account_id (int | None)
statuses (list[PipelineStatus] | None)

id: int | None = None

name: str | None = None

sort: int | None = None

is_main: bool | None = None

is_unsorted_on: bool | None = None

is_archive: bool | None = None

account_id: int | None = None

statuses: list[PipelineStatus] | None = None

classmethod from_dict(data)[исходный код]

Создать экземпляр из словаря API.

Параметры:: data (dict[str, Any])
Тип результата:: Pipeline

to_dict()[исходный код]

Сериализовать в словарь для API, исключая поля со значением None.

Тип результата:: dict[str, Any]

__init__(*, id=None, name=None, sort=None, is_main=None, is_unsorted_on=None, is_archive=None, account_id=None, statuses=None)

Параметры:

id (int | None)
name (str | None)
sort (int | None)
is_main (bool | None)
is_unsorted_on (bool | None)
is_archive (bool | None)
account_id (int | None)
statuses (list[PipelineStatus] | None)

Тип результата:

None