GET
/
partner
/
feedbacks
curl --request GET \
  --url https://api.thanx.com/partner/feedbacks \
  --header 'Authorization: Bearer <token>'
{
  "feedbacks": [
    {
      "id": "590485d6f0",
      "user_id": "fsjlk",
      "merchant_id": "woeri34",
      "location_id": "fgr2349gh",
      "state": "responded",
      "expires_at": "2020-01-07T20:00:00Z",
      "rating": 10,
      "review": "Customer's written review for their latest purchase.",
      "response": "Merchant's written response to the customer's review.",
      "purchase": {
        "id": "916895d48a",
        "purchased_at": "2020-01-01T20:00:00Z",
        "amount": 16.0,
        "order": {
          "id": "aepo3cme2p",
          "provider": "Toast"
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}

This endpoint will return all the feedback records of the specified merchant.

Scope required: feedbacks.read

Parameters

merchant_id
string
required

Filter by Merchant ID

user_id
string

Filter by User ID

states
array[string]

Filter by state (unviewed, viewed, expired, rated, reviewed, responded). The default is to return all feedback records regardless of state.

updated_at
datetime

Filter by the timestamp the feedback record was last updated (ISO8601-format)

page
integer

The current page of paginated resources.

  • Default: 1.
per_page
integer

Number of records to be returned per API request.

  • Default: 10
  • Minimum: 1
  • Maximum: 100

Response

id
string

The ID of the tier status record

user_id
string

The user ID

merchant_id
string

The merchant ID

location_id
string

Location ID

state
enum

The state of the feedback record

  • unviewed - User has an opportunity to leave feedback for a purchase they have made, but has not been displayed the feedback prompt yet.
  • viewed - User viewed the opportunity to leave feedback, but they have not left a NPS or review yet.
  • expired - User did not leave a NPS or review before the feedback expired
  • rated - User has left a net promoter score
  • reviewed - User has left a review
  • responded - Merchant has responded to the user's feedback
expires_at
string

The feedback expiration time in ISO8601-format. Users cannot submit a rating or review for the associated purchase after this time has elapsed.

rating
integer

NPS score (null or 1-10)

review
string

Customer feedback

response
string

Merchant response

purchase
hash

The associated purchase record

pagination
hash

Pagination information