--- updatedAt: 2026-06-29T14:14:57.000Z agentTools: projectIndex: https://developers.kommo.com/llms.txt --- # Get lead by ID This method allows getting a particular lead data by its ID. **`“with”`parameters** | Parameter | Description | | :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | contacts | Adds information about the contacts associated with the lead to the response | | only\_deleted | If this parameter is passed, the method request will return only the deleted leads that are still restorable in the response. You will receive lead models with the following properties: “id”, modification date and “is\_deleted” = true parameters. | | loss\_reason | Adds detailed information about the lead loss reason to the response | | is\_price\_modified\_by\_robot | Adds a property represents whether the lead sale value was changed last time by Robot to the response | | catalog\_elements | Adds lists items linked to the lead to the response | | source\_id | Adds the lead source ID to the response | | sourсe | Adds information about the source, its ID and name to the response | **Limitations**\ The method is available in accordance with the user’s rights. **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**
Parameter Data type Description
id int Lead ID
name string Lead name
price int Lead sale
responsible_user_id int Lead responsible user ID
group_id int Group ID of the lead responsible user
status_id int ID of the stage the lead is added to, the first stage of the main pipeline by default
pipeline_id int ID of the pipeline the lead is added to
loss_reason_id int Lead loss reason ID
source_id int **GET parameter “with” is required.** Lead source ID.
created_by int Id of the user who created the lead
updated_by int Id of the user who updated the lead
created_at int The time and date the lead was created in the format of Unix Timestamp
updated_at int The time and date the lead was updated in the format of Unix Timestamp
closed_at int The time and date the lead was closed in the format of Unix Timestamp
closest_task_at int The time and date of the closest open task in the format of Unix Timestamp
custom_fields_values array|null An array containing information on the values of custom fields specified for this lead
score int|null Lead score
account_id int Account ID where the lead is located in
labor_cost int Shows how much time was spent working with the lead. Calculation time in seconds.
is_price_modified_by_robot bool **GET parameter “with” is required.** Defines whether the lead sale value was changed by the Robot last time.
_embedded object Embedded entities data
_embedded[loss_reason][loss_reason] object **GET parameter “with” is required.** Lead loss reason
_embedded[loss_reason][id] int Loss reason ID
_embedded[loss_reason][name] string Loss reason name
_embedded[tags] array Lead tags data array
_embedded[tags][0] object Lead tag model
_embedded[tags][0][id] int Tag ID
_embedded[tags][0][name] string Tag name
_embedded[tags][0][color] string/null Tag color
_embedded[contacts] array **GET parameter “with” is required.** Linked contacts data array.
_embedded[contacts][0] object Linked contact data
_embedded[contacts][0][id] ints Linked contact ID
_embedded[contacts][0][is_main][is_main] bool Defines whether the contact is main for the lead
_embedded[companies] array Linked company data array. This array always consists of 1 element as a lead can have only 1 company linked to it.
_embedded[companies][0] object Linked company data
_embedded[companies][0][id] int Linked company ID
_embedded[catalog_elements][catalog_elements] array **GET parameter “with” is required.** Linked lists’ elements data array.
_embedded[catalog_elements][0] object Linked list element data
_embedded[catalog_elements][0][id] int Linked element ID
_embedded[catalog_elements][0][metadata] object Meta-data of the element
_embedded[catalog_elements][0][quantity] int Linked element quantity
_embedded[catalog_elements][0][catalog_id][catalog_id] int ID of the linked element’s list
_embedded[source] object **GET parameter "with" is required**. Lead source
_embedded[source][id] int Lead source ID
_embedded[source][name] string Lead source name
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "kommo-api-references", "version": "1.0" }, "servers": [ { "url": "https://{subdomain}.kommo.com", "variables": { "subdomain": { "default": "subdomain" } } } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/api/v4/leads/{id}": { "get": { "summary": "Get lead by ID", "description": "This method allows getting a particular lead data by its ID.", "operationId": "getting-a-lead-by-its-id", "parameters": [ { "name": "id", "in": "path", "description": "Lead ID", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "with", "in": "query", "description": "This parameter takes a string which may consist of several values (look at the table above) separated by commas.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Request successful": { "value": { "total": 6, "accepted": 1, "declined": 3, "average_sort_time": 44153027, "categories": { "sip": { "total": 2 }, "forms": { "total": 3 }, "chats": { "total": 1 } } } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 152464, "default": 0 }, "name": { "type": "string", "example": "Example lead 2" }, "price": { "type": "integer", "example": 20000, "default": 0 }, "responsible_user_id": { "type": "integer", "example": 8375357, "default": 0 }, "group_id": { "type": "integer", "example": 0, "default": 0 }, "status_id": { "type": "integer", "example": 58141807, "default": 0 }, "pipeline_id": { "type": "integer", "example": 6950551, "default": 0 }, "loss_reason_id": {}, "created_by": { "type": "integer", "example": 0, "default": 0 }, "updated_by": { "type": "integer", "example": 8375357, "default": 0 }, "created_at": { "type": "integer", "example": 1686673337, "default": 0 }, "updated_at": { "type": "integer", "example": 1686748504, "default": 0 }, "closed_at": {}, "closest_task_at": {}, "is_deleted": { "type": "boolean", "example": false, "default": true }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "integer", "example": 184994, "default": 0 }, "field_name": { "type": "string", "example": "Sale" }, "field_code": {}, "field_type": { "type": "string", "example": "checkbox" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "boolean", "example": true, "default": true } } } }, "is_computed": { "type": "boolean", "example": false, "default": true } } } }, "score": {}, "account_id": { "type": "integer", "example": 31361463, "default": 0 }, "labor_cost": {}, "is_price_computed": { "type": "boolean", "example": false, "default": true }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "example": "https://devteam.kommo.com/api/v4/leads/152464?page=1&limit=50" } } } } }, "_embedded": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 2164, "default": 0 }, "name": { "type": "string", "example": "Ex" }, "color": {} } } }, "companies": { "type": "array" } } } } } } } }, "204": { "description": "204", "content": { "text/plain": { "examples": { "The lead with the specified ID does not exist.": { "value": "" } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "User is not authorized": { "value": "{\n \"title\": \"Unauthorized\",\n \"type\": \"https://httpstatus.es/401\",\n \"status\": 401,\n \"detail\": \"Invalid user name or password\"\n}" } }, "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Unauthorized" }, "type": { "type": "string", "example": "https://httpstatus.es/401" }, "status": { "type": "integer", "example": 401, "default": 0 }, "detail": { "type": "string", "example": "Invalid user name or password" } } } } } }, "429": { "description": "429", "content": { "text/plain": { "examples": { "Result": { "value": "" } } } } }, "500": { "description": "500", "content": { "text/plain": { "examples": { "Result": { "value": "" } } } } } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```