Skip to main content
GET
Get a feedback result by ID

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.

Path Parameters

feedback_result_id
integer
required

ID of the feedback result

Response

OK

id
integer
required
Example:

1

business_id
string
required

Business id

Example:

"5409c35a97bbc544d8e26737"

store_code
string | null
required

Your own code for the business, if the survey link carried one

Example:

"FR-0042"

firstname
string | null
required

Firstname of the respondent, if the survey collected it

Example:

"John"

lastname
string | null
required

Lastname of the respondent, if the survey collected it

Example:

"Doe"

nps
integer
required

NPS of the feedback result

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

9

content
string | null
required

Content of the FREE_FORM answer, or null when the survey has none.

When the survey has several FREE_FORM questions, this holds the last one only: read feedback_result_fields to get every answer.

Example:

"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
enum<string>
required

State of the feedback result

Available options:
treated,
not_treated
optin
enum<boolean>
required

Whether the respondent accepts to be contacted

Available options:
true,
false
created
string<date-time>
required

Date the feedback result was created on

Example:

"2024-10-25T15:12:11+00:00"

feedback_form
object
required

Information about the corresponding feedback form

feedback_result_fields
object[]
required

The various fields of the feedback result

comments
object[]
required

The replies of the feedback result

extra
object
required

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

Example:
issues
enum<string>[] | null

Data quality issues flagged on the feedback result, if any

Available options:
deleted_business,
missing_store_code,
deleted_user
Example:

null