Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Headers

X-Impersonate-Email
string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

tags
string[]

Filter by tags (OR logic). Can be specified multiple times or comma-separated.

no_tags
enum<string>

Set to "true" to filter for conversations with no tags

Available options:
true,
false
text
string

Search text within the conversation name or chat history (case-insensitive)

created_by
string

Only conversations created by this user — me, a user id or an email. An unknown user returns no rows. Non-admins only ever see their own conversations, so this cannot widen their list.

agent_settings
string<uuid>

Only conversations run with this agent (agent settings id).

created_after
string<date-time>

Only conversations created at or after this ISO 8601 datetime.

created_before
string<date-time>

Only conversations created strictly before this ISO 8601 datetime.

updated_after
string<date-time>

Only conversations last active (updated) at or after this ISO 8601 datetime.

updated_before
string<date-time>

Only conversations last active (updated) strictly before this ISO 8601 datetime.

ordering
enum<string>
default:-created_at

Sort order. -created_at (newest first, default), created_at (oldest first) or -updated_at (most recent activity first).

Available options:
-created_at,
created_at,
-updated_at
include_archived
enum<string>

Set to "true" to include archived conversations in results. Defaults to false (active conversations only).

Available options:
true,
false
limit
integer
default:100

Maximum number of results per page

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0

Response

Successful response

count
integer

Total number of results

next
string<uri> | null

URL to next page of results

previous
string<uri> | null

URL to previous page of results

results
object[]