Synup
Créer une clé
v1Ressources/Reviews/getLister les avis

Lister les avis

Renvoie les avis d'un établissement. locationId et clientId sont tous deux obligatoires.

get/api/v1/reviews
reviews:read
Paramètres de requête
locationIdstringobligatoire
L'établissement à consulter.
clientIdstringobligatoire
Le client de l'établissement.
sitesstringfacultatif
Plateformes d'avis à inclure, séparées par des virgules (ex. google,facebook).
ratingsstringfacultatif
Notes en étoiles à inclure, séparées par des virgules (ex. 1,2).
sentimentstringfacultatif
Sentiments à inclure, séparés par des virgules (positive, neutral, negative).
statusstring (responded | unreplied)facultatif
Filtrer par statut de réponse : responded ou unreplied.
keywordstringfacultatif
Recherche en texte libre dans le corps de l'avis et l'auteur.
fromstringfacultatif
Début de la fenêtre (date ISO).
tostringfacultatif
Fin de la fenêtre (date ISO).
sortstring (newest | oldest | lowest | highest)facultatif
Ordre de tri : newest, oldest, lowest ou highest.
deletedstring (1)facultatif
Passer 1 pour afficher les avis supprimés/absents au lieu des avis actifs.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente.
limitintegerfacultatif
Avis par page, 1-100. Par défaut 30.
Réponse
dataobjectfacultatif
foundbooleanfacultatif
Si l'établissement a été trouvé et était accessible à cette clé.
reviewsarray of objectfacultatif
Les avis eux-mêmes.
idstringfacultatif
Identifiant unique de l'avis.
authorstringfacultatif
Nom de l'auteur de l'avis, ou null si non fourni par la source.
ratingnumberfacultatif
Note en étoiles, ou null.
bodystringfacultatif
Le texte de l'avis.
reviewDatestringfacultatif
Date de publication de l'avis, au format horodatage ISO 8601, ou null.
platformstringfacultatif
Plateforme source, par ex. google, facebook.
platformLabelstringfacultatif
Nom d'affichage de la plateforme source, ou null.
sentimentstringfacultatif
Sentiment détecté de l'avis, ou null.
replyobjectfacultatif
La réponse de l'entreprise, le cas échéant, ou null.
authorstringfacultatif
bodystringfacultatif
datestringfacultatif
reviewUrlstringfacultatif
Lien vers l'avis sur sa plateforme source, ou null.
respondablebooleanfacultatif
Si une réponse peut encore être publiée à cet avis.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null s'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total d'avis correspondant à la requête.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews
Votre clé 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
  }
}

Guides qui utilisent cet endpoint