latestOpenAPI 3.0.02026-08-10416661.5 MB
e96b3e58b041
Conversations
Get user`s conversations
REQUIRED SCOPES <code>['conversations:read']</code><br> Retrieves the list of all the conversations of a specific contact id. <br><br>List can be limited. Returned conversations can be initially ordered: <ul><li>By filter</li> <li>By time of the last event</li> <li>By query</li> <li>Excluding conversation by id </li></ul> <p>Every conversation in the list returns with a specific contact id, owner, and recent message.</p>
get/conversations
Query parameters
filter'open' | 'closed' | 'unread' | 'assigned' | 'unassigned' | 'outbound' | 'optout' | 'nocalls' required
Example:open
Filter (assigned,unassigned only if current user is on team)
limitinteger required
Limit
offsetinteger
Offset
beforestring date
Last message before
afterstring date
Last message after
excludeinteger
Exclude conversation by id
querystring
Contact first_name, last_name, email, number
grouped_responseboolean
Is return grouped response
Response
OK