KOkommo

Get lead subscribers

Changed on

The method allows to get lead subscribers

get/api/v4/leads/{id}/subscriptions

Request

  • Base URL
    https://subdomain.kommo.com
  • URL
    https://subdomain.kommo.com/api/v4/leads/{id}/subscriptions
  • Auth
    OAuth 2

Path parameters

idinteger required

Lead ID

Query parameters

pageinteger

A page of response

limitinteger

The number of entities returned per request (limit – 250)

Response

OK

_total_itemsinteger
_pageinteger
_page_countinteger

Example response

{
  "_total_items": 2,
  "_page": 1,
  "_page_count": 1,
  "_links": {
    "self": {
      "href": "https://subdomain.kommo.com/api/v4/leads/1234567/subscriptions?page=1&limit=250"
    }
  },
  "_embedded": {
    "subscriptions": [
      {
        "subscriber_id": 9876543,
        "type": "user"
      }
    ]
  }
}

Changes