Skip to main content
GET
Search for feedback results

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. Use a comma-separated list to provide multiple ids.

Example:

"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"

business__notin
string[]

Excludes from the request all businesses provided

Business id

state__in
enum<string>[]

State of the feedback result

State of the feedback result

Available options:
treated,
not_treated
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

NPS of the feedback result

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

9

nps__gte
integer

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

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

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

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

Maximum array length: 6
optin
enum<boolean>

Whether the respondent accepts to be contacted

Available options:
true,
false
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