List feedback records with filters

GET/v1/feedback-records

Lists feedback records with optional filters and pagination

Query ParametersExpand Collapse

tenant_id: string

Tenant ID (required for isolation). NULL bytes not allowed.

minLength1

cursor: optional string

Omit for the first page. For the next page, use the exact value from the previous response's next_cursor. Opaque (base64-encoded); keyset pagination.

field_group_id: optional string

Filter by field group ID (for ranking/matrix questions). NULL bytes not allowed.

field_id: optional string

Filter by field ID. NULL bytes not allowed.

field_type: optional "text" or "categorical" or "nps" or 6 more

Filter by field type. NULL bytes not allowed.

Accepts one of the following:

"text"

"categorical"

"nps"

"csat"

"ces"

"rating"

"number"

"boolean"

"date"

limit: optional number

Number of results to return (max 1000)

formatint64

minimum1

maximum1000

since: optional string

Filter by collected_at >= since (ISO 8601 format). Must be between 1970-01-01 and 2080-12-31.

formatdate-time

source_id: optional string

Filter by source ID (NULL bytes not allowed)

source_type: optional string

Filter by source type. NULL bytes not allowed.

submission_id: optional string

Filter by submission ID to group records belonging to one logical submission. NULL bytes not allowed.

until: optional string

Filter by collected_at <= until (ISO 8601 format). Must be between 1970-01-01 and 2080-12-31.

formatdate-time

user_identifier: optional string

Filter by user identifier. NULL bytes not allowed.

ReturnsExpand Collapse

data: array of FeedbackRecordData { id, collected_at, created_at, 18 more }

List of feedback records

id: string

UUIDv7 primary key

formatuuid

collected_at: string

When the feedback was collected

formatdate-time

created_at: string

When this record was created

formatdate-time

field_id: string

Identifier for the question/field

field_type: "text" or "categorical" or "nps" or 6 more

Type of field

Accepts one of the following:

"text"

"categorical"

"nps"

"csat"

"ces"

"rating"

"number"

"boolean"

"date"

source_type: string

Type of feedback source

submission_id: string

Identifier for the logical submission this record belongs to (required).

tenant_id: string

Tenant/organization identifier. NULL bytes not allowed.

updated_at: string

When this record was last updated

formatdate-time

field_group_id: optional string

Stable identifier grouping related fields (for ranking, matrix, grid questions)

field_group_label: optional string

Human-readable question text for the group

field_label: optional string

The actual question text

language: optional string

ISO language code. NULL bytes not allowed.

metadata: optional map[unknown]

Additional context

source_id: optional string

Reference to survey/form/ticket ID

source_name: optional string

Human-readable name

user_identifier: optional string

User identifier

value_boolean: optional boolean

Boolean response

value_date: optional string

Date response

formatdate-time

value_number: optional number

Numeric response

formatdouble

value_text: optional string

Text response. NULL bytes not allowed.

limit: number

Limit used in query

formatint64

next_cursor: optional string

Opaque cursor for the next page (keyset paging). Present only when there may be more results. Use as the cursor query param for the next page.

List feedback records with filters

curl http://localhost:8080/v1/feedback-records \
    -H "Authorization: Bearer $HUB_API_KEY"

{
  "data": [
    {
      "id": "018e1234-5678-9abc-def0-123456789abc",
      "collected_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "source_type": "survey",
      "field_id": "q1",
      "field_type": "rating",
      "field_label": "How satisfied are you?",
      "value_number": 9,
      "source_id": "survey-123",
      "source_name": "Q1 NPS Survey",
      "user_identifier": "user-abc-123",
      "tenant_id": "org-123",
      "submission_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 100
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation failed",
  "instance": "https://hub.formbricks.com/v1/feedback-records",
  "errors": [
    {
      "location": "body.field_id",
      "message": "Field is required",
      "value": null
    }
  ]
}

Returns Examples

{
  "data": [
    {
      "id": "018e1234-5678-9abc-def0-123456789abc",
      "collected_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "source_type": "survey",
      "field_id": "q1",
      "field_type": "rating",
      "field_label": "How satisfied are you?",
      "value_number": 9,
      "source_id": "survey-123",
      "source_name": "Q1 NPS Survey",
      "user_identifier": "user-abc-123",
      "tenant_id": "org-123",
      "submission_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 100
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation failed",
  "instance": "https://hub.formbricks.com/v1/feedback-records",
  "errors": [
    {
      "location": "body.field_id",
      "message": "Field is required",
      "value": null
    }
  ]
}