---
title: "Search for feedback results"
method: GET
path: "/feedback/feedback_result"
tags: ["Feedback Management"]
---

# Search for feedback results

`GET /feedback/feedback_result`

<Warning>
The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**.

If you are planning to use any of them, please **notify us** so we will be able to keep you informed about upcoming changes.
</Warning>

This endpoint lets you search for the feedback results of your businesses.

The response is paginated (30 results per page).

## Query parameters

- `business__in` BusinessId[]
- `business__notin` BusinessId[]
- `state__in` FeedbackResultState[]
- `created__lte` string, datetime
- `created__gte` string, datetime
- `nps__lte` integer — NPS of the feedback result
- `nps__gte` integer — NPS of the feedback result
- `nps__in` Nps[]
- `search` string[]
- `optin` true | false
- `feedback_form_ids` FeedbackFormId[]

## Response `200`

OK

- object
  - `page` integer — Current page number
  - `max_page` integer — Last page number
  - `count` integer — Number of resources complying with filters
  - `items` FeedbackResult[] — Filtered feedback results
    - `id` integer
    - `business_id` string — Business id
    - `store_code` string, nullable — Store code of the business, as reported in the hidden fields at survey time
    - `firstname` string — Firstname of the respondent
    - `lastname` string — Lastname of the respondent
    - `nps` integer — NPS of the feedback result
    - `content` string — Content of the FREE_FORM field
    - `state` 'treated' | 'not_treated' — State of the feedback result
    - `optin` true | false — Whether the respondent accepts to be contacted
    - `created` string, datetime — Date the feedback result was created on
    - `feedback_form` object — Information about the corresponding feedback form
      - `id` string — The unique identifier of the form
      - `display_name` string — Name of your form
      - `custom_hidden_fields` object — Custom hidden fields configured on the form, keyed by field ID, valued by display name
    - `feedback_result_fields` FeedbackResultField[] — The various fields of the feedback result
      - `rating` integer, nullable — Rating assigned by the respondent, if any Is set for CSAT and NPS fields
      - `content` string, nullable — Text content written by the respondent, if any Is set for FREE_FORM fields
      - `choices` string[], nullable — Choices selected by the respondent Is set for MULTIPLE_CHOICE fields
      - `feedback_form_field` FeedbackFormField
        - `id` string — Unique identifier of the field
        - `field_type` 'NPS' | 'FREE_FORM' | 'CSAT' | 'MULTIPLE_CHOICE'
        - `field_label` string — The label of the field (i.e. the question that was answered)
        - `field_choices` object[], nullable — All choices that were ever available for this field Only set for MULTIPLE_CHOICE fields
          - `id` string
          - `text` string
          - `isOtherOption` boolean — Whether this is the "Other" option
    - `comments` FeedbackResultReply[] — The replies of the feedback result
      - `id` integer — Unique identifier of the reply
      - `created` string, datetime — Date the reply was created
      - `author_name` string — Author of the reply
      - `content` string — Content of the reply
      - `feedback_result_id` integer — Identifier of the feedback result
      - `user_id` string — User id
      - `is_reply_suggestion` boolean — Whether the reply was created using an AI suggestion
    - `extra` object — The additional hidden fields (other than `firstname`, `lastname`, `store_code`, `email` and `date`)
    - `issues` FeedbackResultIssue[], nullable — Data-quality issues flagged on this feedback result, if any

## Other responses

- `400` — Your request is incorrect
- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)
