Skip to main content
GET
/
feedback
/
feedback_result
Search for feedback results
curl --request GET \
  --url https://api.partoo.co/v2/feedback/feedback_result \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "items": [
    {
      "id": 1,
      "business_id": "5409c35a97bbc544d8e26737",
      "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.",
      "state": "treated",
      "optin": true,
      "created": "2024-10-25T15:12:11+00:00",
      "feedback_form": {
        "id": "674d791c13c9d976e20001b1",
        "display_name": "Global Satisfaction"
      },
      "feedback_result_fields": [
        {
          "rating": 4,
          "content": null,
          "choices": null,
          "feedback_form_field": {
            "id": "674d7aaa13e599deae0001b2",
            "field_type": "CSAT",
            "field_label": "How would you rate our service?",
            "field_choices": null
          }
        }
      ],
      "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",
          "is_reply_suggestion": false
        }
      ],
      "extra": {
        "extra_field": "value",
        "extra_field_2": "value_2"
      }
    }
  ]
}

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

business__in
string[]

Filter by business ids

Business id

business__notin
string[]

Excludes from the request all businesses provided

Business id

state__in
enum<string>[]

State of the feedback result

Example:

"treated,not_treated"

created__lte
string<datetime>

Max date the feedback result was created on

Example:

"2024-10-01T00:00:00Z"

created__gte
string<datetime>

Min date the feedback result was created on

Example:

"2024-11-01T00:00:00Z"

nps__lte
integer

Max NPS of the feedback result

Required range: 0 <= x <= 10
Example:

9

nps__gte
integer

Min NPS of the feedback result

Required range: 0 <= x <= 10
Example:

9

nps__in
integer[]

The possible NPS values of the feedback result

NPS of the feedback result

Example:

"0,1,2,8,9,10"

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

Maximum length: 6
optin
boolean

Whether the respondent accepts to be contacted

feedback_form_ids
string[]

The forms for which the feedback result is for

The unique identifier of the form

Response

OK

page
integer

Current page number

Example:

1

max_page
integer

Last page number

Example:

10

count
integer

Number of resources complying with filters

Example:

287

items
object[]

Filtered feedback results