Перейти к основному содержимому

PaginatedResponse[LeadRead]

items object[]required
  • Array [
    • idIdrequired

    Уникальный числовой идентификатор записи.

    product_idProduct Idrequired

    Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

    customer_id object

    Канонический идентификатор клиента на уровне компании, связывающий лид с эпизодами общения в других продуктах и каналах; null для ещё не сопоставленных записей.

    anyOf
    integer
    stage_idStage Idrequired

    Идентификатор этапа воронки.

    stage_set_at objectrequired

    Когда лид перешёл на текущий этап (UTC).

    anyOf
    date-time
    start_modeLeadStartModerequired

    Как лид попал в систему. "outbound" — лид уже существовал в базе, и по нему запустили исходящую рассылку. "inbound" — лида раньше не было, он создан из входящего сообщения в известном канале, у привязки которого к агенту включён приём входящих (AgentChannelConfig.inbound_enabled).

    Possible values: [inbound, outbound]

    started_at object

    Когда у лида впервые появилась значимая активность в диалоге (неизменяемая точка отсчёта когорты, UTC).

    anyOf
    date-time
    started_dialogue_id object

    Идентификатор диалога, с которого началась активность по лиду (неизменяемая точка отсчёта).

    anyOf
    integer
    first_outreach_dialogue_id object

    Идентификатор первого исходящего (outreach) диалога по лиду (неизменяемая точка отсчёта).

    anyOf
    integer
    first_reply_dialogue_id object

    Идентификатор первого диалога, в котором лид ответил (неизменяемая точка отсчёта).

    anyOf
    integer
    name objectrequired

    Отображаемое имя лида.

    anyOf
    string
    crm_id objectrequired

    Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

    anyOf
    string
    crm_fields objectrequired

    Произвольные пары ключ/значение, синхронизируемые с внешней CRM в обе стороны.

    property name* object
    anyOf
    string
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    is_testIs Test

    Помечает тестового лида; исключается из продуктовых метрик.

    Default value: false
    batch_name objectrequired

    Необязательная метка, объединяющая лиды, импортированные или созданные одной партией.

    anyOf
    string
    timezone objectrequired

    Часовой пояс IANA (например, "Europe/Moscow"), используемый для планирования отправки в рабочие часы.

    anyOf
    string
    status objectrequired

    Необязательная произвольная строка статуса.

    anyOf
    string
    is_activeIs Activerequired

    Активен ли лид. Деактивированные лиды исключаются из рассылок и автоматизаций.

    from_crm_integration_id objectrequired

    Идентификатор интеграции с CRM, из которой импортирован лид, если применимо.

    anyOf
    integer
    from_pipeline_id objectrequired

    Идентификатор исходной воронки CRM, из которой импортирован лид, если применимо.

    anyOf
    string
    crm_missing_since object

    Заполняется, когда соответствующую запись в CRM больше не удаётся найти (UTC); null, пока запись в CRM существует.

    anyOf
    date-time
    crm_external_takeover_since object

    Заполняется, когда запись в CRM переходит в несопоставленную воронку или этап (UTC); null, пока лид остаётся в сопоставленном состоянии CRM.

    anyOf
    date-time
    merged_into_lead_id object

    Заполняется, когда сделка лида была объединена с другой сделкой на стороне CRM: идентификатор лида, за которым закреплена уцелевшая сделка. Сам лид сохраняет тот crm_id, с которым был импортирован (эта сделка больше не существует), деактивируется, а его диалоги отключаются. Для обычных лидов — null.

    anyOf
    integer
    merged_at object

    Когда лид был объединён с другим лидом (UTC); для обычных лидов — null.

    anyOf
    date-time
  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[LeadRead]
    {
      "items": [
        {
          "id": 0,
          "product_id": 0,
          "customer_id": 0,
          "stage_id": 0,
          "stage_set_at": "2024-07-29T15:51:28.071Z",
          "start_mode": "inbound",
          "started_at": "2024-07-29T15:51:28.071Z",
          "started_dialogue_id": 0,
          "first_outreach_dialogue_id": 0,
          "first_reply_dialogue_id": 0,
          "name": "string",
          "crm_id": "string",
          "crm_fields": {},
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z",
          "is_test": false,
          "batch_name": "string",
          "timezone": "string",
          "status": "string",
          "is_active": true,
          "from_crm_integration_id": 0,
          "from_pipeline_id": "string",
          "crm_missing_since": "2024-07-29T15:51:28.071Z",
          "crm_external_takeover_since": "2024-07-29T15:51:28.071Z",
          "merged_into_lead_id": 0,
          "merged_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }