List conversations with the Crisp API

Lists the conversations of a workspace, with session_id, state, unread counts, assigned operator, last message and the visitor meta (nickname, email, phone, segments). Pages start at 1, and a page with fewer items than per_page is the last one.

Identifier
crisp_list_conversations

The request

POST https://connect.reportei.com/api/tools/crisp_list_conversations/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "website_id": "<website_id>",
    "page_number": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
website_idstringYesId of the workspace, from List websites.
page_numberintegerYesPage number, starting at 1.
per_pageintegerNoConversations per page, from 20 to 50. Defaults to 20.
search_querystringNoText to search in the conversations when search_type is text, or the name of a segment when search_type is segment.
search_typestringNoHow search_query is read: text for a full text search, segment for the conversations tagged with that segment.Values: text, segment
filter_unreadstringNo1 returns only conversations with unread messages.Values: 0, 1
filter_resolvedstringNo1 returns only resolved conversations.Values: 0, 1
filter_not_resolvedstringNo1 returns only conversations that are not resolved.Values: 0, 1
filter_assignedstringNoReturns only the conversations assigned to this operator: the user_id inside details, from List operators.
filter_unassignedstringNo1 returns only conversations with no assigned operator.Values: 0, 1
filter_date_startstringNoOnly conversations updated from this moment on, in ISO 8601, like 2026-10-01T00:00:00.000Z.
filter_date_endstringNoOnly conversations updated up to this moment, in ISO 8601.
order_date_createdstringNo1 orders by creation date instead of the default order.Values: 0, 1
order_date_updatedstringNo1 orders by last update instead of the default order.Values: 0, 1
order_date_waitingstringNo1 orders by the longest wait for an answer and leaves out the conversations that are not waiting.Values: 0, 1
include_emptystringNo1 also returns conversations without any message. Defaults to 0.Values: 0, 1

Supported connections

Your customer connects their Crisp account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/crisp_list_conversations. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.