Skip to main content
GET
Get feedbacks grouped by conversation

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

status
enum<string>

Filter by conversation status (based on feedback statuses)

  • to_review: Feedback pending review (default). Setting this on a closed feedback reopens it and clears reviewed_at/reviewed_by.
  • reviewed: Feedback has been reviewed
  • dismissed: Closed without action (won't fix, or archived praise)
Available options:
to_review,
reviewed,
dismissed
sentiment
enum<string>

Sentiment bucket, applied before the per-conversation counts are computed — so a conversation holding only positive feedback disappears from the review buckets rather than appearing with a count of zero. actionable is negative or neutral. An unknown value is a 400.

Available options:
actionable,
positive,
all

Search in feedback text or user email (case-insensitive)

include_archived
enum<string>

Set to "true" to include feedbacks from archived conversations. Defaults to false.

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[]

Flat array of conversation groups and ungrouped feedbacks, sorted by last updated feedback. Ungrouped feedbacks appear as single-item groups with conversation_id: null.