Listar avaliações

GET

Markdown (LLM)

Retorna as avaliações da empresa.

Escopo:reviews:read

Limite:100 requisições a cada 3 minutos.

Parâmetros de query

pageinteger

Página atual da lista.

1

limitinteger

Quantidade de itens por página.

20

sortstring

Ordem da lista: mais recentes (desc) ou mais antigos (asc).

Enum

ascCrescente
descDecrescente (padrão)

"desc"

merchantIdinteger

Filtra por cardápio.

39202

createdAtFromstring (yyyy-mm-dd)

Início do período, o dia inicial é incluído. Pode ser enviado sozinho.

"2026-10-01"

createdAtTostring (yyyy-mm-dd)

Fim do período; o dia final é incluído. Pode ser enviado sozinho e não pode ser menor que createdAtFrom.

"2026-10-09"

Parâmetros da resposta

pagenumber

Página atual da lista.

1

limitnumber

Quantidade de itens por página.

20

totalnumber

Total de registros encontrados.

1

pagesnumber

Total de páginas.

1

Linguagem

Produção

Requisição

GET /v1/store/reviews

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/store/reviews?createdAtFrom=2026-10-01&createdAtTo=2026-10-09&page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

1234567891011121314151617181920212223{
  "items": [
    {
      "reviewId": 670978,
      "storeId": 38311,
      "merchantId": 39202,
      "customerId": 1001,
      "consumerId": 2001,
      "orderId": 123,
      "name": "Cliente Exemplo",
      "phone": "11999990000",
      "comment": "Muito bom",
      "averageRating": 5,
      "origin": "DIGITAL_MENU_DELIVERY",
      "published": false,
      "createdAt": "2026-08-31T10:11:26.450Z"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1,
  "pages": 1
}