Kommo

Overview

Overview of V4MOS.AI Kommo API

The V4MOS.AI Kommo API centralizes leads, contacts, pipelines, and users synced from Kommo accounts connected to your organization. All endpoints live under the /v1/kommo prefix and follow the same authentication, pagination, and response patterns used across the platform.

Available Endpoints

Authentication

All endpoints require the x-client-id and x-client-secret headers, plus the organizationId query parameter. See Authentication.

Common Parameters

  • organizationId (required) – Organization that owns the Kommo integration
  • integrationId – Integration ID
  • page – Page number (default: 1)
  • limit – Records per page (default: 500, max: 5000)
  • createdStart / createdEnd – Filter by creation timestamp
  • lastModifiedStart / lastModifiedEnd – Filter by last update timestamp

Resource-Specific Filters

Leads (/v1/kommo/leads)

  • leadId, statusId, pipelineId, responsibleUserId, groupId
  • lossReasonId
  • tagId, tagName, tagColor
  • tagIdFirst, tagNameFirst, tagColorFirst
  • createdStart / createdEnd
  • lastModifiedStart / lastModifiedEnd

Contacts (/v1/kommo/contacts)

  • createdStart / createdEnd
  • lastModifiedStart / lastModifiedEnd

Pipelines (/v1/kommo/pipelines)

  • pipelineName, pipelineId
  • statusId, statusName
  • sort, color, type

Users (/v1/kommo/users)

  • userId

Kommo Data Model Highlights

Leads

  • Identification: lead_id, pipeline_id, status_id
  • Ownership and value: responsible_user_id, group_id, price, labor_cost
  • Lifecycle: created_at, updated_at, closed_at, inserted_at
  • Sources: source_id, source_name
  • Relationships: contacts_ids
  • Metadata: loss_reason_id, source_id, source_name

Contacts

  • Profile: id, email
  • Ownership: responsible_user_id, group_id
  • Lifecycle: created_at, updated_at, closest_task_at, inserted_at
  • Flags: is_deleted, is_unsorted
  • Relationships: id_leads

Pipelines

  • Identification: pipeline_id, pipeline_name
  • Status metadata: status_id, status_name, pipeline_sort, sort
  • Configuration: color, type, is_editable

Users

  • Identity: user_id, lang
  • Access: rights, is_admin, is_active, is_free
  • Organization: group_id, role_id

Responses

All responses follow the standard format:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

On this page