Sign in

v1

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

Search for feedback results

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

get/feedback/feedback_result

Query parameters

business__inBusinessId[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

[
  "5409c35a97bbc544d8e26737"
]
business__notinBusinessId[]

Excludes from the request all businesses provided

[
  "5409c35a97bbc544d8e26737"
]
state__inFeedbackResultState[]

State of the feedback result

created__ltestring datetime
Example:2024-10-01T00:00:00Z

Max date the feedback result was created on

created__gtestring datetime
Example:2024-11-01T00:00:00Z

Min date the feedback result was created on

nps__lteinteger

NPS of the feedback result

Example:9

Max NPS of the feedback result

nps__gteinteger

NPS of the feedback result

Example:9

Min NPS of the feedback result

nps__inNps[]

The possible NPS values of the feedback result

[
  9
]
searchstring[]

The possible words contained in the text field of the feedback result

optintrue | false

Whether the respondent accepts to be contacted

feedback_form_idsFeedbackFormId[]

The forms for which the feedback result is for

[
  "674d791c13c9d976e20001b1"
]

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "items": [
    {
      "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"
      }
    }
  ]
}