Getting a pipeline stage data by its ID

get https://{subdomain}.kommo.com/api/v4/leads/pipelines/{pipeline_id}/statuses/{id}

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

Limitations
The method is available for all account users.

Authorization type
OAuth 2.0 with Access Token/ Long-lived token

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters
The method returns a stages objects array. The properties of the stage object are listed below.

Parameter	Data type	Description
int	int	Stage ID
name	string	Stage name
sort	int	Sequence number of the stage in the pipeline
is_editable	bool	Defines whether the stage can be edited
pipeline_id	int	The ID of the pipeline the stage is located in
color	string	Stage color
type	int	Stage type (1 – incoming leads, 0 – regular stage)
account_id	int	Account ID the stage is located in

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://subdomain.kommo.com/api/v4/leads/pipelines/pipeline_id/statuses/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401

403403

429429

500500