Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Feedback Management

Get a feedback result by ID

<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 retrieve a single feedback result by its ID.

get/feedback/feedback_result/{feedback_result_id}

Path parameters

feedback_result_idinteger required

ID of the feedback result

Response

OK

idinteger
business_idstring

Business id

store_codestring nullable

Store code of the business, as reported in the hidden fields at survey time

firstnamestring

Firstname of the respondent

lastnamestring

Lastname of the respondent

npsinteger

NPS of the feedback result

contentstring

Content of the FREE_FORM field

state'treated' | 'not_treated'

State of the feedback result

optintrue | false

Whether the respondent accepts to be contacted

createdstring datetime

Date the feedback result was created on

extraobject

The additional hidden fields (other than firstname, lastname, store_code, email and date)

issuesFeedbackResultIssue[] nullable

Data-quality issues flagged on this feedback result, if any

Example response

{
  "id": 1,
  "business_id": "5409c35a97bbc544d8e26737",
  "store_code": "STORE-042",
  "firstname": "John",
  "lastname": "Doe",
  "nps": 9,
  "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse vulputate efficitur augue, ac auctor nibh scelerisque at. Nulla facilisi. Maecenas luctus efficitur sem sit amet ullamcorper. Donec tempor augue lorem, vitae convallis sapien aliquam id. Maecenas eu odio non est pretium eleifend. Nullam at odio eu ligula ultrices tincidunt. Nulla euismod aliquet ex eget efficitur.",
  "created": "2024-10-25T15:12:11+00:00",
  "feedback_form": {
    "id": "674d791c13c9d976e20001b1",
    "display_name": "Global Satisfaction",
    "custom_hidden_fields": {
      "custom_field_1": "Campaign"
    }
  },
  "feedback_result_fields": [
    {
      "rating": 4,
      "feedback_form_field": {
        "id": "674d7aaa13e599deae0001b2",
        "field_type": "CSAT",
        "field_label": "How would you rate our service?"
      }
    }
  ],
  "comments": [
    {
      "id": 1,
      "created": "2024-11-15T10:00:15+00:00",
      "author_name": "Jane Doe",
      "content": "Thank you for your feedback",
      "feedback_result_id": 1,
      "user_id": "5309c3a237bbc544d8e26737"
    }
  ],
  "extra": {
    "extra_field": "value",
    "extra_field_2": "value_2"
  }
}