CRM links

Получить единую хронологию лида, сделки или клиента

Заметки и системные факты с изменениями полей, дела, смены этапов сделки, решения по лиду, связи и переписка привязанных диалогов одной лентой по возрастанию времени. У записи указан источник: менеджер, API, автоматизация, импорт или слияние. Переписка видна только из диалогов, доступных читающему в разделе «Коммуникации». Лента клиента сверх своих записей собирает события его сделок и лидов, которые читающему доступны. Лента любой записи отдаётся страницами от курсора: без курсора - самые свежие записи; отбор kinds применяется до страницы

get/api/v1/crm/{entity}/{id}/timeline

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/{entity}/{id}/timeline
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Query parameters

limitinteger

Размер страницы ленты: по умолчанию 30, не больше 100. Страница - самые свежие записи раньше курсора

beforestring date-time

Курсор ленты: время самой старой записи, которую экран уже показал; вместе с before_id

before_idstring uuid

Курсор ленты: id самой старой записи, которую экран уже показал; вместе с before

kindsstring
Example:note,engagement

Отбор видов записей через запятую, например note,engagement; пусто - все виды. Неизвестный вид - ошибка 400

Response

Записи ленты от старых к новым

idstring uuid required
kind'note' | 'system' | 'stage' | 'decision' | 'message' | 'link' | 'engagement' | 'file' | 'mail' required

note - заметка сотрудника, system - системный факт или правка полей, stage - смена этапа, decision - решение по лиду, message - сообщение канала, link - связь с задачей, событием или встречей, engagement - дело: звонок, встреча, задача, file - файл прикреплён к записи или удалён, mail - письмо отправлено из карточки, привязано к ней или отвязано

atstring date-time required
actor_idinteger
actor_namestring
titlestring required

Заголовок записи: действие, название этапа, решение или направление сообщения

bodystring
metaobject nullable

Подробности записи. У заметки: mentions - упомянутые коллеги [{id, name}], их имена стоят в тексте как «@Имя»

source'ui' | 'api' | 'automation' | 'import' | 'merge' | 'system'

Откуда пришла запись: ui - менеджер в интерфейсе, api - внешний API, automation - робот, import - импорт, merge - слияние дублей, system - система. Пусто у переписки и у старых записей

record_type'lead' | 'deal' | 'customer'

Запись, которой принадлежит событие. В ленте клиента это его сделка или лид, а не он сам

record_idstring uuid
record_titlestring

Название записи; заполняется только в ленте клиента

Changes

No recorded changes to this operation across all 1 revision of this API.