Sign in

List feedback reviews

GET https://{organization}.myguper.com/api/register/feedback/review

Lists per-order feedback reviews. Supports the standard q[col][OP]=value listing filters (see List query parameters). Useful filters:

  • q[type][]=csat or q[type][]=nps
  • q[rating][GTE]=4 — promoters/satisfied customers
  • q[rating][LTE]=2 — detractors
  • q[personId][]=12345 — all reviews from a customer
  • q[categoryId][]=3 — by category

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Query parameters

Name Type Description
q[column][operator] string Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table.
o[column] string Sort by column. Direction: `ASC`, `DESC`, `1` or `0`.
e integer Items per page. Max `1000`. `0` for unlimited.
default: 20
p integer Page number (≥ 1).
default: 1

Responses

{
    "total": 2,
    "page": 1,
    "rowsPerPage": 20,
    "list": [
        {
            "id": 1,
            "personId": 12345,
            "orderId": "ORD-789",
            "type": "csat",
            "categoryId": 1,
            "rating": 5,
            "comment": "Great delivery, on time and well packaged.",
            "source": "journey",
            "data": null,
            "createdAt": "2026-05-14T11:00:00-03:00",
            "updatedAt": "2026-05-14T11:00:00-03:00"
        },
        {
            "id": 2,
            "personId": 67890,
            "orderId": "ORD-790",
            "type": "nps",
            "categoryId": null,
            "rating": 10,
            "comment": "Would definitely recommend.",
            "source": "journey",
            "data": null,
            "createdAt": "2026-05-14T11:05:00-03:00",
            "updatedAt": "2026-05-14T11:05:00-03:00"
        }
    ]
}

Related

Copied to clipboard