GET /conversations/search

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

Servers

https://services.leadconnectorhq.com

Request headers

Name Type Required Description

Version

String

Yes

API Version

Valid values:

"2021-04-15"

Authorization

String

Yes

Access Token

Query parameters

Name	Type	Required	Description
`scoreProfile`	String	No	Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax
`locationId`	String	Yes	Location Id
`scoreProfileMin`	Number	No	Minimum value for score
`sortBy`	String	No	The sorting of the conversation to be filtered as - manual messages or all messages Valid values: `"score_profile"` `"last_message_date"` `"last_manual_message_date"`
`sort`	String	No	Sort paramater - asc or desc Valid values: `"desc"` `"asc"`
`startAfterDate`	Any	No	Search to begin after the specified date - should contain the sort value of the last document
`lastMessageDirection`	String	No	Direction of the last message in the conversation as string. Valid values: `"inbound"` `"outbound"`
`status`	String	No	The status of the conversation to be filtered - all, read, unread, starred Valid values: `"read"` `"starred"` `"recents"` `"unread"` `"all"`
`contactId`	String	No	Contact Id
`sortScoreProfile`	String	No	Id of score profile on which sortBy.ScoreProfile should sort on
`id`	String	No	Id of the conversation
`query`	String	No	Search paramater as a string
`limit`	Number	No	Limit of conversations - Default is 20
`lastMessageType`	String	No	Type of the last message in the conversation as a string Valid values: `"TYPE_GMB"` `"TYPE_LIVE_CHAT_INFO_MESSAGE"` `"TYPE_SMS_NO_SHOW_REQUEST"` `"TYPE_CAMPAIGN_CALL"` `"TYPE_ACTIVITY_INVOICE"` `"TYPE_ACTIVITY_PAYMENT"` `"TYPE_INSTAGRAM_COMMENT"` `"TYPE_CUSTOM_PROVIDER_SMS"` `"TYPE_IVR_CALL"` `"TYPE_CAMPAIGN_VOICEMAIL"` `"TYPE_CAMPAIGN_SMS"` `"TYPE_CAMPAIGN_MANUAL_CALL"` `"TYPE_CUSTOM_SMS"` `"TYPE_CAMPAIGN_FACEBOOK"` `"TYPE_CAMPAIGN_MANUAL_SMS"` `"TYPE_SMS"` `"TYPE_WHATSAPP"` `"TYPE_EMAIL"` `"TYPE_CUSTOM_PROVIDER_EMAIL"` `"TYPE_REVIEW"` `"TYPE_ACTIVITY_CONTACT"` `"TYPE_CAMPAIGN_EMAIL"` `"TYPE_LIVE_CHAT"` `"TYPE_CUSTOM_EMAIL"` `"TYPE_INSTAGRAM"` `"TYPE_CAMPAIGN_GMB"` `"TYPE_SMS_REVIEW_REQUEST"` `"TYPE_FACEBOOK_COMMENT"` `"TYPE_FACEBOOK"` `"TYPE_ACTIVITY_OPPORTUNITY"` `"TYPE_ACTIVITY_APPOINTMENT"` `"TYPE_WEBCHAT"` `"TYPE_ACTIVITY"` `"TYPE_CALL"`
`lastMessageAction`	String	No	Action of the last outbound message in the conversation as string. Valid values: `"manual"` `"automated"`
`scoreProfileMax`	Number	No	Maximum value for score
`assignedTo`	String	No	Assigned to user Id. Multiple values are comma separated. "unassigned" is used to fetch all unassigned conversations

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.