Skip to main content
GET
List signals

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..

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

status
enum<string>

Filter by signal status

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

Which sentiment bucket to return. actionable means negative or neutral — everything that is work to review. A signal submitted without is_positive is neutral, so filtering on is_positive=false alone hides it.

Available options:
actionable,
positive,
all
is_positive
boolean

Filter by raw sentiment; overrides sentiment when both are given. Prefer sentiment.

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

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

Array of signal objects