v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get pipeline stage by ID

This method allows to get a pipeline stage object by its ID

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

Path parameters

pipeline_idinteger required

Pipeline ID

idinteger required

Stage ID

Query parameters

with'descriptions'

Stage descriptions

Response

200

idinteger

namestring

sortinteger

is_editableboolean

pipeline_idinteger

colorstring

typeinteger

account_idinteger

Example response

{
  "id": 32392156,
  "name": "Incoming Leads",
  "sort": 10,
  "pipeline_id": 3177727,
  "color": "#c1c1c1",
  "type": 1,
  "account_id": 12345678,
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/leads/pipelines/3177727/statuses/32392156"
    }
  }
}