get
https://{subdomain}.kommo.com/api/v4/talks
The method returns a collection of conversations in the account.
Limitations
The method is available to all account users. The returned data depends on the user's rights for the contact associated with the conversation.
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 |
|---|---|---|
| talk_id | int | Conversation ID |
| created_at | int | Conversation creation date as a Unix timestamp |
| updated_at | int | Conversation last update date as a Unix timestamp |
| rate | int | Conversation rating provided by the NPS bot |
| contact_id | int | ID of the contact associated with the conversation |
| chat_id | string | Chat ID associated with the conversation |
| entity_id | int | null | ID of the related entity for the conversation |
| entity_type | string | null | Type of the related entity. Possible values: lead |
| status | string | Conversation status. Possible values: in_work – conversation is active, closed – conversation is closed, nps_scheduled – NPS survey is scheduled, nps_in_progress – NPS survey has been sent and a response is pending, with_error – conversation is active, but an error occurred during the NPS bot workflow. |
| is_in_work | bool | Indicates whether the conversation is open |
| is_read | bool | Indicates whether the conversation is read |
| origin | string | Source type from which the conversation has been created (for example, telegram) |
| source_id | int | null | Conversation source ID |
| account_id | int | Account ID |
| _embedded | object | Embedded entity data |
| _embedded[contacts] | array | Contact data associated with the conversation (maximum 1 contact) |
| _embedded[contacts][0] | object | Contact object |
| _embedded[contacts][0][id] | int | Contact ID |
| _embedded[leads] | array | Lead data associated with the conversation (maximum 1 lead) |
| _embedded[leads][0] | object | Lead object |
| _embedded[leads][0][id] | int | Lead ID |