⭐ List Conversations

GET https://api.crisp.chat/v1/website/:website_id/conversations/:page_number?per_page=&search_query=&search_type=&search_operator=&include_empty=&filter_inbox_id=&filter_unread=&filter_resolved=&filter_not_resolved=&filter_mention=&filter_assigned=&filter_unassigned=&filter_date_start=&filter_date_end=&order_date_created=&order_date_updated=&order_date_waiting=

Request Params

KeyDatatypeRequiredDescription
per_pagenullPage size for conversations paging (between 20 and 50, defaults to 20)
search_querynullSearch query in all conversations (text if type is text or segment, filter if type is filter)
search_typenullSearch type (either text, segment or filter)
search_operatornullSearch operator if search type is filter (or or and respectful to boolean algebra, defaults to and if not set)
include_emptynullWhether to include conversations without any message (1 or 0, defaults to 0)
filter_inbox_idnullWhether to return only conversations categorized under provided inbox identifier
filter_unreadnullWhether to return only conversations with unread messages (1 or 0, defaults to 0)
filter_resolvednullWhether to return only conversations that are resolved (1 or 0, defaults to 0)
filter_not_resolvednullWhether to return only conversations that are not resolved (1 or 0, defaults to 0)
filter_mentionnullWhether to return only conversations where user is mentioned (1 or 0, defaults to 0)
filter_assignednullWhether to return only conversations that are assigned to user identifier
filter_unassignednullWhether to return only conversations that are not assigned to any user (1 or 0, defaults to 0)
filter_date_startnullWhen to start relative to conversation update date (date, ISO 8601, eg. 2018-03-01T17:00:00.000Z)
filter_date_endnullWhen to end relative to conversation update date (date, ISO 8601, eg. 2018-04-01T10:30:00.000Z)
order_date_creatednullWhether to order conversations by date created instead of default order (1 or 0, defaults to 0)
order_date_updatednullWhether to order conversations by date updated instead of default order (1 or 0, defaults to 0)
order_date_waitingnullWhether to order conversations by longest date waiting instead of default order, this also filters out non-waiting conversations (1 or 0, defaults to 0)

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
X-Crisp-Tierstring