REST API

Документация Loomee.CRM API

Управляйте данными CRM из любого сервиса: сайта, 1С, аналитики или собственного приложения. Ниже — базовые методы работы со сделками.

BASEhttps://api.loomee.ru/v1v1 · Beta

Аутентификация

Запросы авторизуются ключом рабочего пространства в заголовке Authorization. Ключ создаётся в кабинете Loomee.CRM в разделе Настройки → API, показывается один раз и хранится у нас только в виде хэша. Каждый ключ несёт привязку к вашему пространству и набор скоупов — обращаться к чужим данным им нельзя.

Заголовки запроса

Authorization: Bearer sk_live_2b7f9c1a…e91
Content-Type: application/json

deals:readdeals:writecontacts:readcontacts:writepipelines:read

Объект «Сделка»

Методы работы со сделками возвращают объект такого вида. Этапы — это данные вашей воронки, а не фиксированный список: перемещение сделки задаётся полем stage_id.

Поля объекта

id	string	опц.	Идентификатор сделки (cuid).
title	string	опц.	Название сделки.
contact_id	string	опц.	Связанный контакт.
pipeline_id	string	опц.	Воронка сделки.
stage_id	string	опц.	Текущий этап воронки.
status	string	опц.	open \| won \| lost. Вычисляется из типа этапа, напрямую не задаётся.
amount	string \| null	опц.	Сумма, десятичная строка.
amount_mode	string	опц.	manual — вписана руками; items — сумма позиций (только чтение).
currency	string	опц.	Валюта ISO 4217, по умолчанию RUB.
assignee_id	string \| null	опц.	Ответственный (Membership.id).
address	string \| null	опц.	Адрес.
comment	string \| null	опц.	Комментарий.
source	string \| null	опц.	Источник сделки.
utm	object	опц.	Метки: source, medium, campaign, content, term.
yclid	string \| null	опц.	Yandex Click ID — атрибуция Яндекс Директ.
closed_at	string \| null	опц.	Момент перехода на won/lost, ISO 8601.
created_at	string	опц.	Дата создания, ISO 8601.
updated_at	string	опц.	Дата изменения, ISO 8601.

Пример объекта

{
  "id": "cly3k2a9f0001qz8b4d2e",
  "title": "Внедрение CRM — ООО «Ромашка»",
  "contact_id": "cly3jd0p20000qz8b1a4c",
  "pipeline_id": "cly3ip5h10000qz8bx9k2",
  "stage_id": "cly3iq7m40002qz8b7f1d",
  "status": "open",
  "amount": "340000.00",
  "amount_mode": "manual",
  "currency": "RUB",
  "assignee_id": "cly3ir2v90003qz8b2m8n",
  "address": null,
  "comment": null,
  "source": "yandex-direct",
  "utm": {
    "source": "yandex",
    "medium": "cpc",
    "campaign": "crm-msk",
    "content": null,
    "term": null
  },
  "yclid": "7654321098765432100",
  "closed_at": null,
  "created_at": "2026-07-20T10:15:00Z",
  "updated_at": "2026-07-25T09:00:00Z"
}

Методы: сделки

Полный набор CRUD-операций над сделками.

GET/dealsdeals:read

Список сделок

Возвращает сделки рабочего пространства с курсорной пагинацией. Поддерживает фильтры по воронке, этапу, статусу, контакту и ответственному.

Query-параметры

limit	integer	опц.	Размер страницы, 1–100. По умолчанию 20.
cursor	string	опц.	Курсор следующей страницы из поля next_cursor.
pipeline_id	string	опц.	Фильтр по воронке.
stage_id	string	опц.	Фильтр по этапу.
status	string	опц.	Фильтр по статусу: open, won, lost.
contact_id	string	опц.	Сделки конкретного контакта.
assignee_id	string	опц.	Сделки ответственного (Membership.id).
query	string	опц.	Поиск по названию сделки.

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

curl "https://api.loomee.ru/v1/deals?status=open&limit=20" \
  -H "Authorization: Bearer sk_live_•••"

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

{
  "data": [
    {
      "id": "cly3k2a9f0001qz8b4d2e",
      "title": "Внедрение CRM — ООО «Ромашка»",
      "contact_id": "cly3jd0p20000qz8b1a4c",
      "pipeline_id": "cly3ip5h10000qz8bx9k2",
      "stage_id": "cly3iq7m40002qz8b7f1d",
      "status": "open",
      "amount": "340000.00",
      "amount_mode": "manual",
      "currency": "RUB",
      "assignee_id": "cly3ir2v90003qz8b2m8n",
      "address": null,
      "comment": null,
      "source": "yandex-direct",
      "utm": {
        "source": "yandex",
        "medium": "cpc",
        "campaign": "crm-msk",
        "content": null,
        "term": null
      },
      "yclid": "7654321098765432100",
      "closed_at": null,
      "created_at": "2026-07-20T10:15:00Z",
      "updated_at": "2026-07-25T09:00:00Z"
    }
  ],
  "next_cursor": "eyJjIjoiMjAyNi0wNy0yMCJ9",
  "has_more": true
}

POST/dealsdeals:write

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

Создаёт сделку. Обязательны название и контакт. Если воронка и этап не указаны — сделка попадает на первый этап воронки по умолчанию. Поддерживает заголовок Idempotency-Key.

Тело запроса (JSON)

title	string	обяз.	Название сделки.
contact_id	string	обяз.	Идентификатор контакта.
pipeline_id	string	опц.	Воронка. По умолчанию — is_default.
stage_id	string	опц.	Этап. По умолчанию — первый этап воронки.
amount	string	опц.	Сумма, десятичная строка, напр. "340000.00".
currency	string	опц.	Валюта ISO 4217. По умолчанию RUB.
assignee_id	string	опц.	Ответственный (Membership.id).
comment	string	опц.	Комментарий к сделке.
source	string	опц.	Источник сделки.
utm	object	опц.	Метки: source, medium, campaign, content, term.
yclid	string	опц.	Yandex Click ID для атрибуции Яндекс Директ.

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

curl -X POST "https://api.loomee.ru/v1/deals" \
  -H "Authorization: Bearer sk_live_•••" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6b9f1c2e-…" \
  -d '{
    "title": "Внедрение CRM — ООО «Ромашка»",
    "contact_id": "cly3jd0p20000qz8b1a4c",
    "amount": "340000.00",
    "yclid": "7654321098765432100"
  }'

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

{
  "id": "cly3k2a9f0001qz8b4d2e",
  "title": "Внедрение CRM — ООО «Ромашка»",
  "contact_id": "cly3jd0p20000qz8b1a4c",
  "pipeline_id": "cly3ip5h10000qz8bx9k2",
  "stage_id": "cly3iq7m40002qz8b7f1d",
  "status": "open",
  "amount": "340000.00",
  "amount_mode": "manual",
  "currency": "RUB",
  "assignee_id": "cly3ir2v90003qz8b2m8n",
  "address": null,
  "comment": null,
  "source": "yandex-direct",
  "utm": {
    "source": "yandex",
    "medium": "cpc",
    "campaign": "crm-msk",
    "content": null,
    "term": null
  },
  "yclid": "7654321098765432100",
  "closed_at": null,
  "created_at": "2026-07-20T10:15:00Z",
  "updated_at": "2026-07-25T09:00:00Z"
}

GET/deals/{id}deals:read

Получить сделку

Возвращает одну сделку по её идентификатору.

Path-параметры

string

обяз.

Идентификатор сделки.

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

curl "https://api.loomee.ru/v1/deals/cly3k2a9f0001qz8b4d2e" \
  -H "Authorization: Bearer sk_live_•••"

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

{
  "id": "cly3k2a9f0001qz8b4d2e",
  "title": "Внедрение CRM — ООО «Ромашка»",
  "contact_id": "cly3jd0p20000qz8b1a4c",
  "pipeline_id": "cly3ip5h10000qz8bx9k2",
  "stage_id": "cly3iq7m40002qz8b7f1d",
  "status": "open",
  "amount": "340000.00",
  "amount_mode": "manual",
  "currency": "RUB",
  "assignee_id": "cly3ir2v90003qz8b2m8n",
  "address": null,
  "comment": null,
  "source": "yandex-direct",
  "utm": {
    "source": "yandex",
    "medium": "cpc",
    "campaign": "crm-msk",
    "content": null,
    "term": null
  },
  "yclid": "7654321098765432100",
  "closed_at": null,
  "created_at": "2026-07-20T10:15:00Z",
  "updated_at": "2026-07-25T09:00:00Z"
}

PATCH/deals/{id}deals:write

Обновить сделку

Частично обновляет сделку — передавайте только меняемые поля. Чтобы переместить сделку по воронке, передайте новый stage_id; статус (open/won/lost) пересчитывается по типу этапа автоматически.

Path-параметры

string

обяз.

Идентификатор сделки.

Тело запроса (JSON)

title	string	опц.	Новое название.
amount	string	опц.	Новая сумма, десятичная строка.
stage_id	string	опц.	Переместить на этап (двигает по воронке).
assignee_id	string	опц.	Сменить ответственного.
comment	string	опц.	Обновить комментарий.

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

curl -X PATCH "https://api.loomee.ru/v1/deals/cly3k2a9f0001qz8b4d2e" \
  -H "Authorization: Bearer sk_live_•••" \
  -H "Content-Type: application/json" \
  -d '{ "stage_id": "cly3iq9w80004qz8b3a7k" }'

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

{
  "id": "cly3k2a9f0001qz8b4d2e",
  "title": "Внедрение CRM — ООО «Ромашка»",
  "contact_id": "cly3jd0p20000qz8b1a4c",
  "pipeline_id": "cly3ip5h10000qz8bx9k2",
  "stage_id": "cly3iq9w80004qz8b3a7k",
  "status": "won",
  "amount": "340000.00",
  "amount_mode": "manual",
  "currency": "RUB",
  "assignee_id": "cly3ir2v90003qz8b2m8n",
  "address": null,
  "comment": null,
  "source": "yandex-direct",
  "utm": {
    "source": "yandex",
    "medium": "cpc",
    "campaign": "crm-msk",
    "content": null,
    "term": null
  },
  "yclid": "7654321098765432100",
  "closed_at": "2026-07-25T12:40:00Z",
  "created_at": "2026-07-20T10:15:00Z",
  "updated_at": "2026-07-25T12:40:00Z"
}

DELETE/deals/{id}deals:write

Удалить сделку

Удаляет сделку без возможности восстановления. Успешный ответ не содержит тела.

Path-параметры

string

обяз.

Идентификатор сделки.

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

curl -X DELETE "https://api.loomee.ru/v1/deals/cly3k2a9f0001qz8b4d2e" \
  -H "Authorization: Bearer sk_live_•••"

Пример ответа204 No Content

— (пустой ответ)

Нужен доступ к API?

Получите API-ключ и тестовую среду вместе с демо Loomee.CRM.