v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get pipeline by ID

This method allows getting a single pipeline object by its ID.

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

Path parameters

idinteger required

Pipeline ID

Response

200

idinteger

namestring

sortinteger

is_mainboolean

is_unsorted_onboolean

is_archiveboolean

account_idinteger

Example response

{
  "id": 6950551,
  "name": "Pipeline",
  "sort": 1,
  "is_main": true,
  "is_unsorted_on": true,
  "account_id": 31361463,
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads/pipelines/6950551"
    }
  },
  "_embedded": {
    "statuses": [
      {
        "id": 58141803,
        "name": "Incoming leads",
        "sort": 10,
        "pipeline_id": 6950551,
        "color": "#c1c1c1",
        "type": 1,
        "account_id": 31361463,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141803"
          }
        }
      }
    ]
  }
}