PaginatedResponse[CRMIntegrationSafeRead]

items object[]required

Array [

idIdrequired

Unique numeric identifier of the record.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

name objectrequired

Optional human-readable integration name.

anyOf

• string
• null

string

crm_typeCrm Typerequired

The CRM system — amocrm, kommo, bitrix24, fasttrack, usedesk, or google_sheets.

Possible values: [amocrm, bitrix24, fasttrack, kommo, usedesk, google_sheets]

is_activeIs Activerequired

Whether the integration is active.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

config objectrequired

Non-secret CRM configuration (e.g. pipeline mapping, rate limits).

lead_modeLead Mode

Possible values: [lead, deal]

Default value: deal

google_sheets object

anyOf

• GoogleSheetsConfig
• null

sheet_url object

anyOf

• string
• null

string

sheet_name object

anyOf

• string
• null

string

pipeline_idPipeline Id

Default value: google_sheets_pipeline

mapping object

crm_id_column object

anyOf

• string
• null

string

name_column object

anyOf

• string
• null

string

contact_column object

anyOf

• string
• null

string

contact_type_column object

anyOf

• ContactType
• null

ContactType

Possible values: [phone, username, chat_id, email]

contact_platform_column object

anyOf

• string
• null

string

contact_type_defaultContactType

Possible values: [phone, username, chat_id, email]

Default value: phone

contact_platform_default object

anyOf

• string
• null

string

Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

stage_columnStage Column

Default value: stage

crm_fields_columnsstring[]

document_columnsstring[]

dialogue_history_column object

anyOf

• string
• null

string

crm_fields_dump_column object

anyOf

• string
• null

string

summary_column object

anyOf

• string
• null

string

rate_limit_requestsRate Limit Requests

Default value: 7

rate_limit_periodRate Limit Period

Default value: 1

responsible_whitelist_enabledResponsible Whitelist Enabled

Default value: false

responsible_whiteliststring[]

crm_id_whiteliststring[]

crm_id_whitelist_enabledCrm Id Whitelist Enabled

Default value: false

skip_if_multiple_recent_ticketsSkip If Multiple Recent Tickets

Default value: false

skip_if_multiple_recent_tickets_threshold_hoursSkip If Multiple Recent Tickets Threshold Hours

Default value: 72

]

pagePagerequired

limitLimitrequired

totalTotalrequired

pagesPagesrequired

PaginatedResponse[CRMIntegrationSafeRead]

{
  "items": [
    {
      "id": 0,
      "company_id": 0,
      "name": "string",
      "crm_type": "amocrm",
      "is_active": true,
      "created_at": "2024-07-29T15:51:28.071Z",
      "config": {
        "lead_mode": "deal",
        "google_sheets": {
          "sheet_url": "string",
          "sheet_name": "string",
          "pipeline_id": "google_sheets_pipeline",
          "mapping": {
            "crm_id_column": "string",
            "name_column": "string",
            "contact_column": "string",
            "contact_type_column": "phone",
            "contact_platform_column": "string",
            "contact_type_default": "phone",
            "contact_platform_default": "telegram",
            "stage_column": "stage",
            "crm_fields_columns": [
              "string"
            ],
            "document_columns": [
              "string"
            ],
            "dialogue_history_column": "string",
            "crm_fields_dump_column": "string",
            "summary_column": "string"
          }
        },
        "rate_limit_requests": 7,
        "rate_limit_period": 1,
        "responsible_whitelist_enabled": false,
        "responsible_whitelist": [
          "string"
        ],
        "crm_id_whitelist": [
          "string"
        ],
        "crm_id_whitelist_enabled": false,
        "skip_if_multiple_recent_tickets": false,
        "skip_if_multiple_recent_tickets_threshold_hours": 72
      }
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "pages": 0
}