Synup
Criar chave
v1Recursos/Reviews/getListar avaliações

Listar avaliações

Retorna avaliações de um local. Tanto locationId quanto clientId são obrigatórios.

get/api/v1/reviews
reviews:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringobrigatório
O cliente do local.
sitesstringopcional
Plataformas de avaliação a incluir, separadas por vírgula (ex. google,facebook).
ratingsstringopcional
Classificações em estrelas a incluir, separadas por vírgula (ex. 1,2).
sentimentstringopcional
Sentimentos a incluir, separados por vírgula (positive, neutral, negative).
statusstring (responded | unreplied)opcional
Filtrar por status de resposta: responded ou unreplied.
keywordstringopcional
Busca de texto livre no corpo da avaliação e no autor.
fromstringopcional
Início da janela (data ISO).
tostringopcional
Fim da janela (data ISO).
sortstring (newest | oldest | lowest | highest)opcional
Ordem: newest, oldest, lowest ou highest.
deletedstring (1)opcional
Passe 1 para mostrar avaliações removidas/ausentes em vez das ativas.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior.
limitintegeropcional
Avaliações por página, 1-100. Padrão 30.
Resposta
dataobjectopcional
foundbooleanopcional
Se o local foi encontrado e estava acessível para esta chave.
reviewsarray of objectopcional
As avaliações em si.
idstringopcional
Identificador único da avaliação.
authorstringopcional
Nome de quem avaliou, ou null se não informado pela fonte.
ratingnumberopcional
Classificação em estrelas, ou null.
bodystringopcional
O texto da avaliação.
reviewDatestringopcional
Data de publicação da avaliação, como timestamp ISO 8601, ou null.
platformstringopcional
Plataforma de origem, ex.: google, facebook.
platformLabelstringopcional
Nome de exibição da plataforma de origem, ou null.
sentimentstringopcional
Sentimento detectado da avaliação, ou null.
replyobjectopcional
A resposta da empresa, se houver, ou null.
authorstringopcional
bodystringopcional
datestringopcional
reviewUrlstringopcional
Link para a avaliação na plataforma de origem, ou null.
respondablebooleanopcional
Se ainda é possível publicar uma resposta a esta avaliação.
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalnumberopcional
Número total de avaliações que correspondem à solicitação.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews
Sua chave de API
locationId *
clientId *
sites
ratings
sentiment
status
keyword
from
to
sort
deleted
cursor
limit
{
  "data": {
    "found": true,
    "reviews": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 5,
        "body": "Great service!",
        "reviewDate": "2026-02-01T12:00:00.000Z",
        "platform": "google",
        "platformLabel": "Google",
        "sentiment": "positive",
        "reply": null,
        "reviewUrl": "https://google.com/...",
        "respondable": true
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}

Guias que usam este endpoint