Skip to main content
SearchVersion: v3

Search Conversations

GET/conversations/search

Returns a list of all conversations matching the search criteria along with the sort and filter options selected.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:conversations.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

locationIdstringrequired

Location Id

Example:ABCHkzuJQ8ZMd4Te84GK
contactIdstring

Contact Id

Example:9VEmS0si86GW6gXWU89b
assignedTostring

User IDs that conversations are assigned to. Multiple IDs can be provided as comma-separated values. Use "unassigned" to fetch conversations not assigned to any user.

Example:ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik
followersstring

User IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values.

Example:ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik
mentionsstring

User Id of the mention. Multiple values are comma separated.

Example:ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik
querystring

Search paramater as a string

Example:Search string
sortstring

Sort paramater - asc or desc

Available optionsascdesc
Example:asc
startAfterDateany

Search to begin after the specified date - should contain the sort value of the last document

Example:1600854
idstring

Id of the conversation

Example:ABCHkzuJQ8ZMd4Te84GK
limitnumber

Limit of conversations - Default is 20

Example:20
lastMessageTypestring

Type of the last message in the conversation as a string

Available optionsTYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOK
Example:TYPE_SMS
lastMessageActionstring

Action of the last outbound message in the conversation as string.

Available optionsautomatedmanual
Example:manual
lastMessageDirectionstring

Direction of the last message in the conversation as string.

Available optionsinboundoutbound
Example:inbound
statusstring

The status of the conversation to be filtered - all, read, unread, starred

Available optionsallreadunreadstarredrecents
Example:all
sortBystring

The sorting of the conversation to be filtered as - manual messages or all messages

Available optionslast_manual_message_datelast_message_datescore_profile
Example:last_message_date
sortScoreProfilestring

Id of score profile on which sortBy.ScoreProfile should sort on

Example:ABCHkzuJQ8ZMd4Te84GK
scoreProfilestring

Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax

Example:ABCHkzuJQ8ZMd4Te84GK
scoreProfileMinnumber

Minimum value for score

Example:ABCHkzuJQ8ZMd4Te84GK
scoreProfileMaxnumber

Maximum value for score

Example:ABCHkzuJQ8ZMd4Te84GK

Response

Successfully fetched the conversations

conversationsobject[]required

The list of all conversations found for the given query

totalnumberrequired

Total Number of results found for the given query

Example:100