Search Conversations

post

https://api.whippy.co/v1/conversations/search

Search conversations in an organization.

Conversations with no last_message_date will be excluded as they're regarded as empty.

The default offset is 0 and the default limit is 50. The max limit is 500.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search Conversation Params

assigned_users

array of strings

IDs of users that are assigned to conversations

assigned_users

channels

array of objects

Filter by channels

channels

contacts

array of objects

Filter by contacts

contacts

created_at

object

Created At Date in ISO 8601

last_message_date

object

Last Message Date in ISO 8601

limit

integer

Number of results to return

offset

integer

Number of results to skip

sort

object

Sorting options

status

array of strings

Statuses list

status

type

array of strings

Filter by conversation channel_type. Same as type[] on list conversations: pass one or more values in a list.

type

unread_count

integer

Filter by unread count

updated_at

object

Updated At Date in ISO 8601

Responses

Callback

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Conversations

401Not Authenticated