--- title: "WT AmoCRM library (Joomla) — Entities API - WebTolk websites development, Joomla Extensions" description: "Reference for WT AmoCRM entities (Webtolk\\Amocrm\\Entities): concise summaries of the methods for leads, contacts, notes, tags, users, webhooks, and custom fields with usage snippets." url: "https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/documentation/wt-amocrm-library-joomla-entities-api" date: "2026-06-19T04:11:15+00:00" language: "en-GB" --- # WT AmoCRM library (Joomla) — Entities API WT Amo CRM library - Documentation **Category:** [Libraries](https://web-tolk.ru/en/dev/biblioteki) [Project](https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library)[Versions](https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/versions)[Documentation](https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/documentation)[GitHub](https://github.com/WebTolk/WT-Amo-CRM-library-for-Joomla-4) Reference for WT AmoCRM entities (Webtolk\Amocrm\Entities): concise summaries of the methods for leads, contacts, notes, tags, users, webhooks, and custom fields with usage snippets. Documentation for AmoCRM entities provided by the `Webtolk\Amocrm\Entities` namespace. Common usage pattern: ``` use Webtolk\Amocrm\Amocrm; $amocrm = new Amocrm(); // All entities expose facade methods $leads = $amocrm->leads()->getLeads(['limit' => 50]); $contacts = $amocrm->contacts()->getContacts(['limit' => 50]); ``` Every method returns an `object`. On error it yields `{ error_code, error_message }`. ## Account `Webtolk\Amocrm\Entities\Account` - `getAccountInfo(): object` — retrieves account information via `/api/v4/account`. Example: ``` $account = $amocrm->account()->getAccountInfo(); ``` ## Contacts `Webtolk\Amocrm\Entities\Contacts` - `getContacts(array $data = []): object` — list contacts. - `getContactById(int $contact_id, string $with = ''): object` — load a contact by ID. - `addContacts(array $data = []): object` — bulk create contacts. - `editContactsBatch(array $data): object` — batch update. - `editContact(int $contact_id, array $data): object` — single update by ID. Example payload: ``` $payload = [ [ 'name' => 'Ivan Petrov', 'custom_fields_values' => [ [ 'field_code' => 'PHONE', 'values' => [ ['enum_code' => 'WORK', 'value' => '+79990001122'] ] ] ] ] ]; $result = $amocrm->contacts()->addContacts($payload); ``` ## Leads `Webtolk\Amocrm\Entities\Leads` - `getLeadsPiplines(): object` — pipelines via `/api/v4/leads/pipelines`. - `createLeadsComplex(array $data = []): object` — complex creation. - `createLeads(array $data): object` — batch creation. - `getLeadById(int $id, string $with = ''): object` — load lead by ID. - `getLeads(array $data = []): object` — list leads. - `editLeadsBatch(array $data): object` — batch update. - `editLead(int $lead_id, array $data): object` — update single lead by ID. Example (pipelines): ``` $pipelines = $amocrm->leads()->getLeadsPiplines(); ``` ## Customfields `Webtolk\Amocrm\Entities\Customfields` - `getCustomFields(string $entity_type = 'leads', array $data = []): object` — allowed types: `leads`, `contacts`, `companies`, `customers`. - `getLeadsCustomFields()`, `getContactsCustomFields()`, `getCompaniesCustomFields()`, `getCustomersCustomFields()` — helper shortcuts. - `editCustomFieldsBatch(string $entity_type, array $data, ?int $entity_id = null): object` — PATCH `/api/v4/{entity_type}/custom_fields` or `/custom_fields/{id}`. Example: ``` $fields = $amocrm->customfields()->getContactsCustomFields(['limit' => 50]); ``` ## Notes `Webtolk\Amocrm\Entities\Notes` - `addNotes(string $entity_type = 'leads', int $entity_id = 0, array $notes = []): object` - `getNotes(string $entity_type, int $entity_id, array $params = []): object` - `editNotesBatch(string $entity_type, array $data): object` - `editNote(string $entity_type, int $entity_id, array $data, ?int $note_id = null): object` Allowed entity types: `leads`, `contacts`, `companies`, `customers`. Example (adding a text note): ``` $notes = [ [ 'entity_id' => 123456, 'note_type' => 'common', 'params' => ['text' => 'Comment from Joomla'] ] ]; $result = $amocrm->notes()->addNotes('leads', 0, $notes); ``` ## Tags `Webtolk\Amocrm\Entities\Tags` - `getTags(string $entity_type = 'leads', array $data = []): object` Allowed types: `leads`, `contacts`, `companies`, `customers`. Example: ``` $tags = $amocrm->tags()->getTags('leads', ['limit' => 100]); ``` ## Users `Webtolk\Amocrm\Entities\Users` - `getUsers(array $data = []): object` — fetch users. - `getUserById(int $user_id, string $with = ''): object` — load user by ID. - `addUsers(array $data): object` — add users in bulk. - `getRoles(array $data = []): object` — list roles. Example: ``` $users = $amocrm->users()->getUsers(['limit' => 50]); ``` ## Webhooks `Webtolk\Amocrm\Entities\Webhooks` - `getWebhooks(array $data = []): object` — accepts `filter[destination]` (the URL is encoded). - `addWebhook(array $data): object` - `deleteWebhook(string $destination): object` - `getJoomlaWebhookUrl(): string` — builds the `com_ajax` endpoint for incoming webhooks. Example subscription: ``` $data = [ 'destination' => $amocrm->webhooks()->getJoomlaWebhookUrl(), 'settings' => ['lead_status', 'contact_add'] ]; $result = $amocrm->webhooks()->addWebhook($data); ``` ## JSON-LD Schema ```json { "@context": "https://schema.org", "@type": "BreadcrumbList", "@id": "https://web-tolk.ru/#/schema/BreadcrumbList/17", "itemListElement": [ { "@type": "ListItem", "position": 1, "item": { "@id": "https://web-tolk.ru/en", "name": "Home" } }, { "@type": "ListItem", "position": 2, "item": { "@id": "https://web-tolk.ru/en/dev", "name": "Joomla extensions" } }, { "@type": "ListItem", "position": 3, "item": { "@id": "/en/dev/biblioteki", "name": "Libraries" } }, { "@type": "ListItem", "position": 4, "item": { "@id": "/en/dev/biblioteki/wt-amo-crm-library", "name": "WT Amo CRM library" } }, { "@type": "ListItem", "position": 5, "item": { "@id": "/en/dev/biblioteki/wt-amo-crm-library/documentation", "name": "Documentation" } }, { "@type": "ListItem", "position": 6, "item": { "name": "WT AmoCRM library (Joomla) — Entities API" } } ] } ``` ```json { "@context": "https://schema.org", "@graph": [ { "@type": "Organization", "@id": "https://web-tolk.ru/#/schema/Organization/base", "name": "WebTolk", "url": "https://web-tolk.ru/", "logo": { "@type": "ImageObject", "@id": "https://web-tolk.ru/#/schema/ImageObject/logo", "url": "images/webtolk-1080p.jpg", "contentUrl": "images/webtolk-1080p.jpg", "width": 1920, "height": 1080 }, "image": { "@id": "https://web-tolk.ru/#/schema/ImageObject/logo" }, "sameAs": [ "https://github.com/WebTolk", "https://github.com/sergeytolkachyov", "https://vk.com/web_tolk", "https://vk.com/webtolkru", "https://tenchat.ru/sergeytolkachyov", "https://t.me/sergeytolkachyov", "https://t.me/webtolkru" ] }, { "@type": "WebSite", "@id": "https://web-tolk.ru/#/schema/WebSite/base", "url": "https://web-tolk.ru/", "name": "WebTolk websites development, Joomla Extensions", "publisher": { "@id": "https://web-tolk.ru/#/schema/Organization/base" } }, { "@type": "WebPage", "@id": "https://web-tolk.ru/#/schema/WebPage/base", "url": "https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/documentation/wt-amocrm-library-joomla-entities-api", "name": "WT AmoCRM library (Joomla) — Entities API - WebTolk websites development, Joomla Extensions", "description": "Reference for WT AmoCRM entities (Webtolk\\Amocrm\\Entities): concise summaries of the methods for leads, contacts, notes, tags, users, webhooks, and custom fields with usage snippets.", "isPartOf": { "@id": "https://web-tolk.ru/#/schema/WebSite/base" }, "about": { "@id": "https://web-tolk.ru/#/schema/TechArticle/base" }, "inLanguage": "en-GB", "breadcrumb": { "@id": "https://web-tolk.ru/#/schema/BreadcrumbList/17" } }, { "@type": "TechArticle", "headline": "WT AmoCRM library (Joomla) — Entities API", "url": "https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/documentation/wt-amocrm-library-joomla-entities-api", "description": "Reference for WT AmoCRM entities (Webtolk\\Amocrm\\Entities): concise summaries of the methods for leads, contacts, notes, tags, users, webhooks, and custom fields with usage snippets.", "mainEntityOfPage": { "@type": "WebPage", "url": "https://web-tolk.ru/en/dev/biblioteki/wt-amo-crm-library/documentation/wt-amocrm-library-joomla-entities-api" }, "keywords": [ "Joomla", " amocrm", " api", " rest api", " amocrm Entities", " Entities amocrm joomla " ] } ] } ```