v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get conversations

The method returns a collection of conversations in the account.

get/api/v4/talks

Query parameters

pageinteger

Page of response

limitinteger

Number of entities returned per request (limit – 250)

filter[talk_id][]integer[]

Filter by conversation ID. Accepts either a single ID or an array of IDs

filter[contact_id][]integer[]

Filter by contact ID. Accepts either a single ID or an array of IDs

filter[entity_id][]integer[]

Filter by entity ID (lead). Accepts either a single ID or an array of IDs. Must be used together with filter[entity_type]

filter[entity_type]'lead'

Entity type for filtering by entity_id. Possible values: lead

filter[only_in_work]string

The parameter is optional and does not require a value. If present, only open conversations are returned

Response

Request successful