v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get incoming lead by UID

This method allows getting a particular incoming lead data by its UID

get/api/v4/leads/unsorted/{uid}

Path parameters

uidstring required

Incoming lead UID

Response

200

uidstring

source_uidstring

source_namestring

categorystring

pipeline_idinteger

created_atinteger

account_idinteger

Example response

{
  "uid": "9ca097816a45770002e406db35e2a1945364d570b765332cef7a57289fc0",
  "source_uid": "amojo:onlinechat:b4b939f3-5a25-4cab-a4e8-57140f7c72fa",
  "source_name": "onlinechat:1494984c-db73-4ceb-b980-a20a5de569f2",
  "category": "chats",
  "pipeline_id": 6950551,
  "created_at": 1686818940,
  "metadata": {
    "to": "1494984c-db73-4ceb-b980-a20a5de569f2",
    "received_at": 1686818940,
    "service": "onlinechat",
    "origin": {
      "chat_id": "b4b939f3-5a25-4cab-a4e8-57140f7c72fa",
      "visitor_uid": "b2aa4364-7790-4dca-8acc-ab90554f97f8"
    },
    "last_message_text": 1686818940,
    "source_name": "Live chat"
  },
  "account_id": 31361463,
  "_links": {
    "self": {
      "href": "LINK"
    }
  },
  "_embedded": {
    "contacts": [
      {
        "id": 583308,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/contacts/583308"
          }
        }
      }
    ],
    "leads": [
      {
        "id": 236738,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/leads/236738"
          }
        }
      }
    ]
  }
}